Skip to main content

Clipboard namespace

Includes functions dealing with system clipboard.

Methods:​

read()​

Clipboard.read():ClipboardDataObject

returns object containing clipboard data

readText()​

returns either string or undefined if clipboard does not contain textual data.

write()​

Clipboard.write(data:ClipboardDataObject):boolean

Puts data into clipboard.

writeText()​

Clipboard.writeText(string):boolean

Puts the string into clipboard.

has()​

Clipboard.has(type:string):boolean

Checks if clipboard contains data of given type: "text" | "html" | "image" | "file" | "json" | "link".

Clipboard Data Object​

Clipboard data object is a plain JS object that may contain following properties:

  • text: string - text;
  • html: string - html fragment;
  • json: value - arbitrary JSON data;
  • file: [path0,path1, ...] - list of file paths;
  • link: { caption: string, url: string} - link to some file / location;
  • image: Graphics.Image - image object;