# Clipboard Plugin

Online Help

## Description

Clipboard is an action plugin for AutoPlay Media Studio 5.0. It can be used to move text to and get text from the Windows clipboard.

## Actions

### Clipboard.CopyText (string Text);

#### Description:

Copies a string of text to the Windows clipboard.

#### Text:

(string) The text to copy to the clipboard.

#### Returns:

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

#### Example:

    -- Copy some text to the clipboard
    Clipboard.CopyText("Hello World");

### string Clipboard.GetText ();

#### Description:

Retrieves text from the Windows clipboard.

#### Returns:

(string) A string of text from the clipboard, if available. If there is no text available an empty string will be returned. You can use Application.GetLastError to determine whether this action failed, and why.

#### Example:

    -- Display text from the clipboard in a message box
    CBText = Clipboard.GetText();
    Dialog.Message("Clipboard Text", CBText);

### boolean Clipboard.IsTextAvailable ();

#### Description:

Determines whether text is available on the Windows clipboard.

#### Returns:

(boolean) True if text is available or false if text is not available. You can use Application.GetLastError to determine whether this action failed, and why.

#### Example:

    -- Is there any text on the clipboard?
    bTextAvailable = Clipboard.IsTextAvailable();

    -- Inform the user
    if bTextAvailable then
        Dialog.Message("Status", "There is text on the clipboard!");
    else
        Dialog.Message("Status", "There is NO text on the clipboard!");
    end

## Error Codes

12010 - Failed to open clipboard.

## Additional Information

### Author:

Indigo Rose Corporation
support@indigorose.com

### Copyright:

Plugin is copyright © 2003 Indigo Rose Software Design Corporation.

### Website:

http://www.indigorose.com

Copyright © 2003 Indigo Rose Software Design Corporation.
All Rights Reserved.