Clipboard.getText Action

Format

The action does not require any arguments.

Description

The Clipboard.getText action returns text currently on the clipboard. If the clipboard contains data that cannot be represented as text, the action will not return anything.

Return Value

If text is currently on the clipboard, the action returns a string containing the text on the clipboard. If no text is on the clipboard, the action returns undefined.

Exceptions

The action does not throw exceptions.

Example (CSPro Logic)

string clipboardText = CS.Clipboard.getText();

if clipboardText = "" then
clipboardText = "<There was no text on the clipboard.>";
endif;

clipboardText = maketext("Clipboard text modified by CSPro at %s: %s", timestring(), clipboardText);

CS.Clipboard.putText(text := clipboardText);

Example (JavaScript)

let clipboardText = CS.Clipboard.getText();

if( clipboardText === undefined ) {
clipboardText = "<There was no text on the clipboard.>";
}

clipboardText = "Clipboard text modified by CSPro at " +
new Date().toString() + ": " +
clipboardText;

CS.Clipboard.putText({
text: clipboardText
});