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 でソース コードを取得します。

注釈

Clipboard クラスは静的クラスであるため、そのメソッドにアクセスするためにそのインスタンスを作成する必要はありません。

クリップボードにアクセスできるのは、呼び出し元のアプリケーションが 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)