Namespace: Clipboard

Clipboard

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

Methods

getAvailableFormats(type) → {Promise.Array.<string>}

Reads available formats for the clipboard type

Parameters:
Name Type Description
type string

Clipboard Type

Tutorials:
Returns:
Type
Promise.Array.<string>

readHtml(type) → {Promise.<string>}

Read the content of the clipboard as Html

Parameters:
Name Type Description
type string

Clipboard Type

Tutorials:
Returns:
Type
Promise.<string>

readRtf(type) → {Promise.<string>}

Read the content of the clipboard as Rtf

Parameters:
Name Type Description
type string

Clipboard Type

Tutorials:
Returns:
Type
Promise.<string>

readText(type) → {Promise.<string>}

Read the content of the clipboard as plain text

Parameters:
Name Type Description
type string

Clipboard Type

Tutorials:
Returns:
Type
Promise.<string>

write(writeObj) → {Promise.<void>}

Writes data into the clipboard

Parameters:
Name Type Description
writeObj WriteAnyRequestType

This object is described in the WriteAnyRequestType typedef

Tutorials:
Returns:
Type
Promise.<void>

writeHtml(writeObj) → {Promise.<void>}

Writes data into the clipboard as Html

Parameters:
Name Type Description
writeObj WriteRequestType

This object is described in the WriteRequestType typedef

Tutorials:
Returns:
Type
Promise.<void>

writeRtf(writeObj) → {Promise.<void>}

Writes data into the clipboard as Rtf

Parameters:
Name Type Description
writeObj WriteRequestType

This object is described in the WriteRequestType typedef

Tutorials:
Returns:
Type
Promise.<void>

writeText(writeObj) → {Promise.<void>}

Writes data into the clipboard as plain text

Parameters:
Name Type Description
writeObj WriteRequestType

This object is described in the WriteRequestType typeof

Tutorials:
Returns:
Type
Promise.<void>