Namespace: Clipboard

Clipboard

The Clipboard API allows reading and writing to the clipboard in multiple formats.

Synonym: fin.desktop.System.Clipboard

Asynchronous Methods

All the above listed methods are both:

  • Static — called directly on the System namespace
  • Asynchronous — having an undefined immediate return value but eventually invoking either callback or errorCallback
To Do:
  • Make sure any edits to this Table of Contents are also made to docs home page (/docs-README.md)!!

Methods

(static) availableFormats(typeopt, callbackopt, errorCallbackopt)

Reads available formats for the clipboard type

Parameters:
Name Type Attributes Description
type string <optional>

Clipboard Type.

callback function <optional>

called if the method succeeds. Provides the Array of available formats.

errorCallback function <optional>

called if the method fails. The reason for failure is passed as an argument.

Tutorials:

(static) readHtml(typeopt, callbackopt, errorCallbackopt)

Read the content of the clipboard as Html

Parameters:
Name Type Attributes Description
type string <optional>

Clipboard Type.

callback function <optional>

called if the method succeeds. Provides the clipboard contents

errorCallback function <optional>

called if the method fails. The reason for failure is passed as an argument.

Tutorials:

(static) readRtf(typeopt, callbackopt, errorCallbackopt)

Read the content of the clipboard as Rtf

Parameters:
Name Type Attributes Description
type string <optional>

Clipboard Type.

callback function <optional>

called if the method succeeds. Provides the clipboard contents

errorCallback function <optional>

called if the method fails. The reason for failure is passed as an argument.

Tutorials:

(static) readText(typeopt, callbackopt, errorCallbackopt)

Read the content of the clipboard as plain text

Parameters:
Name Type Attributes Description
type string <optional>

Clipboard Type.

callback function <optional>

called if the method succeeds. Provides the clipboard contents

errorCallback function <optional>

called if the method fails. The reason for failure is passed as an argument.

Tutorials:

(static) write(data, typeopt, callbackopt, errorCallbackopt)

Writes data into the clipboard

Parameters:
Name Type Attributes Description
data object

Object containing data to be written.

type string <optional>

Clipboard Type.

callback function <optional>

called if the method succeeds.

errorCallback function <optional>

called if the method fails. The reason for failure is passed as an argument.

Tutorials:

(static) writeHtml(data, typeopt, callbackopt, errorCallbackopt)

Writes data into the clipboard as Html

Parameters:
Name Type Attributes Description
data string

Data to be written.

type string <optional>

Clipboard Type.

callback function <optional>

called if the method succeeds.

errorCallback function <optional>

called if the method fails. The reason for failure is passed as an argument.

Tutorials:

(static) writeRtf(data, typeopt, callbackopt, errorCallbackopt)

Writes data into the clipboard as Rtf

Parameters:
Name Type Attributes Description
data string

Data to be written.

type string <optional>

Clipboard Type.

callback function <optional>

called if the method succeeds.

errorCallback function <optional>

called if the method fails. The reason for failure is passed as an argument.

Tutorials:

(static) writeText(data, typeopt, callbackopt, errorCallbackopt)

Writes data into the clipboard as plain text

Parameters:
Name Type Attributes Description
data string

Data to be written.

type string <optional>

Clipboard Type.

callback function <optional>

called if the method succeeds.

errorCallback function <optional>

called if the method fails. The reason for failure is passed as an argument.

Tutorials: