Class Clipboard

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

Namespace

Hierarchy

Base
- Clipboard

Index

Constructors

Properties

Accessors

Methods

getAvailableFormats readHtml readRtf readText write writeHtml writeRtf writeText

Constructors

constructor

new Clipboard(wire: Transport<EntityType>): Clipboard
Parameters
- wire: Transport<EntityType>
Returns Clipboard

Inherited from Base.constructor

Properties

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from Base.me

Methods

getAvailableFormats

getAvailableFormats(type?: string): Promise<string[]>
Reads available formats for the clipboard type

Returns

Tutorial
Clipboard.getAvailableFormats
Parameters
- Optional type: string
  
  Clipboard Type
Returns Promise<string[]>

readHtml

readHtml(type?: string): Promise<string>
Read the content of the clipboard as Html

Returns

Tutorial
Clipboard.readHtml
Parameters
- Optional type: string
  
  Clipboard Type
Returns Promise<string>

readRtf

readRtf(type?: string): Promise<string>
Read the content of the clipboard as Rtf

Returns

Tutorial
Clipboard.readRtf
Parameters
- Optional type: string
  
  Clipboard Type
Returns Promise<string>

readText

readText(type?: string): Promise<string>
Read the content of the clipboard as plain text

Returns

Tutorial
Clipboard.readText
Parameters
- Optional type: string
  
  Clipboard Type
Returns Promise<string>

write

write(writeObj: WriteAnyRequestType): Promise<void>
Writes data into the clipboard

Returns

Tutorial
Clipboard.write
Parameters
- writeObj: WriteAnyRequestType
  
  This object is described in the WriteAnyRequestType typedef
Returns Promise<void>

writeHtml

writeHtml(writeObj: WriteRequestType): Promise<void>
Writes data into the clipboard as Html

Returns

Tutorial
Clipboard.writeHtml
Parameters
- writeObj: WriteRequestType
  
  This object is described in the WriteRequestType typedef
Returns Promise<void>

writeRtf

writeRtf(writeObj: WriteRequestType): Promise<void>
Writes data into the clipboard as Rtf

Returns

Tutorial
Clipboard.writeRtf
Parameters
- writeObj: WriteRequestType
  
  This object is described in the WriteRequestType typedef
Returns Promise<void>

writeText

writeText(writeObj: WriteRequestType): Promise<void>
Writes data into the clipboard as plain text

Returns

Tutorial
Clipboard.writeText
Parameters
- writeObj: WriteRequestType
  
  This object is described in the WriteRequestType typeof
Returns Promise<void>

Generated using TypeDoc