FMX.Clipboard.IFMXExtendedClipboardService.SetCustomFormat

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure SetCustomFormat(const AFormatName: string; const AStream: TStream);

C++

virtual void __fastcall SetCustomFormat(const System::UnicodeString AFormatName, System::Classes::TStream* const AStream) = 0 ;

Properties

Type Visibility Source Unit Parent
procedure
function
public
FMX.Clipboard.pas
FMX.Clipboard.hpp
FMX.Clipboard IFMXExtendedClipboardService

Description

Fills the system clipboard with the specified stream of data in the specified registered custom format.

Exceptions

SetCustomFormat may raise one of the following exceptions:

Exception Message Scenarios

EArgumentException

AFormat parameter cannot be empty

EArgumentNilException

AStream parameter cannot be nil

  • The specified data stream, AStream, is nil. You must specify an instance of TStream.

EClipboardFormatNotRegistered

<AFormatName>

  • The specified custom format identifier, AFormatName, has not been registered. You must register any custom format identifier before you use it.

ENotSupportedException

JClipboardManager does not support custom data

See Also