FMX.Clipboard.IFMXExtendedClipboardService

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

IFMXExtendedClipboardService = interface(IFMXClipboardService)

C++

__interface  INTERFACE_UUID("{E96E4776-8234-49F9-B15F-301074E23F70}") IFMXExtendedClipboardService  : public Fmx::Platform::IFMXClipboardService

Properties

Type Visibility Source Unit Parent
interface
class
public
FMX.Clipboard.pas
FMX.Clipboard.hpp
FMX.Clipboard FMX.Clipboard

Description

Platform service to interact with the system clipboard.

Note: The FMX.Platform unit provides another interface to interact with the system clipboard, IFMXClipboardService. However, IFMXExtendedClipboardService provides additional features.

IFMXExtendedClipboardService provides three types of methods to interact with the content of the system clipboard:

  • A Has<Format> method to determine if the system clipboard currently contains data in the specified format.
  • A Get<Format> method to read the contents of the system clipboard in the specified format. You should only use Get<Format> when Has<Format> returns True.
  • A Set<Format> method to write data into the system clipboard in the specified format.

The following table shows those methods:

Text Format Image Format Custom Format
HasText HasImage HasCustomFormat
GetText GetImage GetCustomFormat
SetText SetImage SetCustomFormat

Before you can use the custom format method to read or write arbitrary data into the system clipboard, you must register an identifier for your custom format.

Platform Support

Platform Text Format Image Format Custom Format
Windows
YesC++11Feature.png
YesC++11Feature.png
YesC++11Feature.png
OS X
YesC++11Feature.png
YesC++11Feature.png
YesC++11Feature.png
iOS
YesC++11Feature.png
YesC++11Feature.png
YesC++11Feature.png
Android
YesC++11Feature.png
3.0+

The Android clipboard does not support images. To allow users to copy and paste images between your own applications, you can use a custom format instead.