FMX.Clipboard.IFMXExtendedClipboardService.GetCustomFormat

• Up to Parent: IFMXExtendedClipboardService

Delphi

function GetCustomFormat(const AFormatName: string; const AStream: TStream): Boolean;

C++

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

Properties

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

Description

Fills the specified data stream with the content of the system clipboard and returns True on success or False otherwise.

If the content of the system clipboard is not in the specified custom format, GetCustomFormat returns False and the specified data stream is not modified. Otherwise, GetCustomFormat returns True.

Exceptions

GetCustomFormat may raise one of the following exceptions:

Exception	Message	Scenarios
EArgumentException	AFormat parameter cannot be empty	The specified custom format identifier, AFormatName, is an empty string. You must specify a valid custom format identifier.
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	You are using an Android version lower than 3.0, which does not support clipboard data in a custom data format. Warning: FireMonkey itself does not support your Android device, see Android Devices Supported for Application Development.

See Also

• FMX.Clipboard.IFMXExtendedClipboardService.HasCustomFormat
• FMX.Clipboard.IFMXExtendedClipboardService.SetCustomFormat
• FMX.Clipboard.IFMXExtendedClipboardService.RegisterCustomFormat

• FMX.Clipboard.IFMXExtendedClipboardService.GetText
• FMX.Clipboard.IFMXExtendedClipboardService.GetImage