TClipboard.SetFormat function

Declaration

function SetFormat(FormatID: TClipboardFormat; Stream: TStream)
: Boolean

Arguments

Description

SetFormat is a Boolean function used to select the clipboard format for the format identifier in FormatID, and load the content in Stream. It calls AddFormat to select the supported format in FormatID, and to cache values in Stream to its TClipboardData record instance.

SetFormat calls BeginUpdate prior to activating the format and loading its value. It calls EndUpdate when the operation has been completed. The value from EndUpdate is used as the return value for the method.

SetFormat is called when TGraphic or TPicture class instances are loaded to the clipboard in the Assign method.

See also

• AddFormat
• Assign
• TClipboardFormat