[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;

Arguments

FormatID

  

Clipboard format identifier (TClipboardFormat) updated in the method.

Stream

  

TStream instance with the content for the specified clipboard format.

Function result

True if format added correctly.

Arguments

FormatID

  

Clipboard format identifier (TClipboardFormat) updated in the method.

Buffer

  

Untyped, updatable buffer with the content stored for the clipboard format.

Size

  

Number of bytes in Buffer stored in the method.

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 the private AsText and SetTextBuf.

Version 4.0 Generated 2025-05-03 Home