Show: Delphi C++
Display Preferences

FMX.Clipboard.IFMXExtendedClipboardService.RegisterCustomFormat

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure RegisterCustomFormat(const AFormatName: string);

C++

virtual void __fastcall RegisterCustomFormat(const System::UnicodeString AFormatName) = 0 ;

Properties

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

Description

Registers the specified identifier for a custom data format that you can use read or write arbitrary data into the system clipboard.

AFormatName must be an arbitrary, non-empty string that identifies your custom data format. For example, you can use a media type identifier, or something as simple as "MyFormat". Apple recommends using a Uniform Type Identifier (UTI).

Exceptions

RegisterCustomFormat 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.

EClipboardFormatRegisterError

Custom clipboard format with name "<AFormatName>" is already registered

  • The specified custom format identifier, AFormatName, is already registered. Use IsCustomFormatRegistered to check whether a given custom format identifier is already registered or not before you attempt to register it.

<Windows-specific error message>

See Also

Personal tools
In Other Languages
Previous Versions
Assistance