[Overview][Types][Classes][Procedures and functions][Index] Reference for unit 'Clipbrd' (#lcl)

TClipboard.AddFormat

Acquires ownership of the Clipboard and adds a format.

Declaration

Source position: clipbrd.pp line 188

public function TClipboard.AddFormat(

  FormatID: TClipboardFormat;

  Stream: TStream

):Boolean;

function TClipboard.AddFormat(

  FormatID: TClipboardFormat;

  var Buffer;

  Size: Integer

):Boolean;

Function result

True if format added correctly.

Description

If not already done, this function acquires ownership of the clipboard. Acquiring ownership clears the clipboard. If the format already exists, it replaces the old content. Otherwise, it is added. The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions instead.