The following commands allow interacting with clipboards. The “name” argument given to each command is the name as assigned by the user when the clipboard was created.
Any place a name is required you may instead substitute a (1-based) index. When accessed by index, clipboards are ordered alphabetically by name.
New Clipboard name
Creates a new clipboard with the specified name, which should not already be in use. This is the only clipboard command that does not accept an index instead of a name.
Delete Clipboard name
Deletes the specified clipboard.
Switch to Clipboard name
Makes the specified clipboard the active (current) clipboard.
Edit Clipboard [name]
Edits the specified clipboard. If a name is omitted then the current is edited.
Read Clipboard [name]
Returns the contents of the specified clipboard. If name is omitted then the current clipboard contents are read.
Write Clipboard contents, [name]
Changes the value of the specified clipboard. If the name is omitted, then the current clipboard contents are changed.
Append to Clipboard contents, [name]
Appends the contents to the specified clipboard. The name can be omitted to use the current clipboard.
Clipboard Name [index] v1.0.1
Returns the name of the Nth clipboard, or if the index is omitted, then the name of the current clipboard.
Clipboard Index [name] v1.2
Returns the index of the clipboard with the given name, or if the name is omitted, then the index of the current clipboard. If no clipboard with the given name exists, returns the @undefined value. The returned index is 1-based.
Clipboard Count
Returns the number of clipboards the user has created.
Clipboard Exists name v1.0.2
Returns @true if a clipboard with the given name exists, otherwise @false.
Previous Chapter User Interaction |
<< index >> |
Next Chapter Environment |