Clipboard Clipboard Clipboard Clipboard Clipboard Class

Definition

Gets and sets information from the clipboard object.

public : static class Clipboard
static struct winrt::Windows::ApplicationModel::DataTransfer::Clipboard
public static class Clipboard
Public Static Class Clipboard
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

The following sample shows how to track changes to the Clipboard. If the Clipboard has text, the code adds the text to an HTML page.

Windows.ApplicationModel.DataTransfer.Clipboard.addEventListener("contentchanged", function (event) {
    var dataPackageView = Windows.ApplicationModel.DataTransfer.Clipboard.getContent();
    if (dataPackageView.contains(Windows.ApplicationModel.DataTransfer.StandardDataFormats.text)) {
        dataPackageView.getTextAsync().then(function (text) {
            // To output the text from this example, you need an HTML element
            // with an id of "output".
            document.getElementById("output").innerText = "Clipboard now contains: " + text;
        });
    }
});

Remarks

Because the Clipboard class is a static class, you don't need to create an instance of it to access its methods.

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX) and Using Windows Runtime objects in a multithreaded environment (.NET).

You can only access the clipboard when the calling application is in focus on the UI thread (e.g., when it's CoreWindow is active). Use the CoreWindow.Activated event to track the state of the calling app.

Methods

Clear() Clear() Clear() Clear() Clear()

Removes all data from the Clipboard.

Flush() Flush() Flush() Flush() Flush()

Adds the content to the Clipboard and releases the DataPackage object from the source app. This method allows the content to remain available after the application shuts down.

GetContent() GetContent() GetContent() GetContent() GetContent()

Gets the current content that is stored in the clipboard object.

SetContent(DataPackage) SetContent(DataPackage) SetContent(DataPackage) SetContent(DataPackage) SetContent(DataPackage)

Sets the current content that is stored in the clipboard object.

Events

ContentChanged ContentChanged ContentChanged ContentChanged ContentChanged

Occurs when the data stored in the Clipboard changes.

See Also