Clipboard 类

定义

命名空间:

Windows.ApplicationModel.DataTransfer

获取和设置剪贴板对象中的信息。

public ref class Clipboard abstract sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Clipboard final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public static class Clipboard

Public Class Clipboard

继承

Object Platform::Object IInspectable Clipboard

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 要求

设备系列	Windows 10 (在 10.0.10240.0 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

示例

以下示例演示如何跟踪剪贴板的更改。 如果剪贴板包含文本，则代码会将文本添加到 HTML 页。

private async void TrackClipboardChanges_EventHandler(object sender, object e)
{
    DataPackageView dataPackageView = Clipboard.GetContent();
    if (dataPackageView.Contains(StandardDataFormats.Text))
    {
        String text = await dataPackageView.GetTextAsync();

        // To output the text from this example, you need a TextBlock control
        // with a name of "TextOutput".
        TextOutput.Text = "Clipboard now contains: " + text;
    }
}

提示

有关详细信息、设计指南和代码示例，请参阅 复制和粘贴。

打开 WinUI 3 库应用，查看操作中的剪贴板功能。

WinUI 3 库应用包括大多数 WinUI 3 控件、特性和功能的交互式示例。 通过 Microsoft Store 获取应用，或在 GitHub 上获取源代码

注解

由于剪贴板类是静态类，因此无需创建它的实例来访问其方法。

仅当调用应用程序焦点位于 UI 线程 (（例如，当其 CoreWindow) 处于活动状态时），才能访问剪贴板。 使用 CoreWindow.Activated 事件跟踪调用应用的状态。

版本历史记录

Windows 版本	SDK 版本	已添加值
1809	17763	ClearHistory
1809	17763	DeleteItemFromHistory
1809	17763	GetHistoryItemsAsync
1809	17763	HistoryChanged
1809	17763	HistoryEnabledChanged
1809	17763	IsHistoryEnabled
1809	17763	IsRoamingEnabled
1809	17763	RoamingEnabledChanged
1809	17763	SetContentWithOptions
1809	17763	SetHistoryItemAsContent

方法

Clear()	从剪贴板中移除所有数据。
ClearHistory()	清除剪贴板历史记录。
DeleteItemFromHistory(ClipboardHistoryItem)	从剪贴板历史记录中删除指定的项。
Flush()	将内容添加到剪贴板，并从源应用释放 DataPackage 对象。 此方法允许内容在应用程序关闭后保持可用。
GetContent()	获取存储在剪贴板对象中的当前内容。
GetHistoryItemsAsync()	获取剪贴板历史记录中当前存在的项的列表。
IsHistoryEnabled()	指示剪贴板历史记录 (即是否为当前用户启用将多个项保存到剪贴板) 的功能。
IsRoamingEnabled()	指示是否为当前用户将剪贴板数据设置为跨设备同步。
SetContent(DataPackage)	设置剪贴板对象中存储的当前内容。
SetContentWithOptions(DataPackage, ClipboardContentOptions)	使用内容选项设置剪贴板对象中存储的内容。
SetHistoryItemAsContent(ClipboardHistoryItem)	将剪贴板历史记录中的项设置为剪贴板的当前内容。

事件

ContentChanged	当剪贴板中存储的数据发生更改时发生。
HistoryChanged	在将新项添加到剪贴板历史记录时发生。
HistoryEnabledChanged	更改控制是否为当前用户启用剪贴板历史记录的 OS 设置时发生。
RoamingEnabledChanged	更改了控制剪贴板数据是否设置为跨设备同步当前用户的 OS 设置时发生。

另请参阅

• 剪贴板示例 (Windows 10)