Clipboard.SetDataObject メソッド

定義

名前空間:

System.Windows

アセンブリ:

PresentationCore.dll

指定したデータ オブジェクトをシステム クリップボードに格納します。

オーバーロード

SetDataObject(Object)	指定した非永続的なデータ オブジェクトをシステム クリップボードに配置します。
SetDataObject(Object, Boolean)	指定したデータ オブジェクトをシステム クリップボードに配置し、そのデータ オブジェクトをアプリケーションの終了時にクリップボードに残すかどうかを示すブール型パラメーターを受け入れます。

SetDataObject(Object)

指定した非永続的なデータ オブジェクトをシステム クリップボードに配置します。

public:
 static void SetDataObject(System::Object ^ data);

public static void SetDataObject (object data);

static member SetDataObject : obj -> unit

Public Shared Sub SetDataObject (data As Object)

パラメーター

data

Object

システム クリップボードに配置するデータ オブジェクト (IDataObject を実装するオブジェクト)。

例外

ArgumentNullException

data が nullです。

ExternalException

クリップボードへのアクセス中にエラーが発生しました。 例外の詳細には、特定のエラーを識別する HResult が含まれます。「ErrorCode」を参照してください。

注釈

既定では、 を使用してシステム クリップボード SetDataObject に配置されたデータは、アプリケーションの終了時にクリップボードから自動的に消去されます。

注意

アプリケーションの終了時にクリップボードをクリアする既定の動作は、他の実装とは異なる場合があり、既定でクリアするのではなく、アプリケーションの終了時にクリップボードにデータを残す可能性があります。 オーバーロードを SetDataObject 使用し、アプリケーション終了時に copy クリップボードからデータをクリアしない場合のように true パラメーターを指定します。

DataObject は、 インターフェイスの基本的な実装を IDataObject 提供します。

こちらもご覧ください

• GetDataObject()

SetDataObject(Object, Boolean)

指定したデータ オブジェクトをシステム クリップボードに配置し、そのデータ オブジェクトをアプリケーションの終了時にクリップボードに残すかどうかを示すブール型パラメーターを受け入れます。

public:
 static void SetDataObject(System::Object ^ data, bool copy);

public static void SetDataObject (object data, bool copy);

static member SetDataObject : obj * bool -> unit

Public Shared Sub SetDataObject (data As Object, copy As Boolean)

パラメーター

data

Object

システム クリップボードに配置するデータ オブジェクト (IDataObject を実装するオブジェクト)。

copy

Boolean

アプリケーションの終了時にデータをシステム クリップボードに残す場合は true。アプリケーションの終了時にデータをシステム クリップボードから消去する場合は false。

例外

ArgumentNullException

data が nullです。

ExternalException

クリップボードへのアクセス中にエラーが発生しました。 例外の詳細には、特定のエラーを識別する HResult が含まれます。「ErrorCode」を参照してください。

例

次の例では、このメソッドの使用方法を示します。

               // For this example, the data to be placed on the clipboard is a simple
               // string.
               string textData = "I want to put this string on the clipboard.";
               // The example will enable auto-conversion of data for this data object.
               bool autoConvert = true;

               // Create a new data object, specifying the data format, data to encapsulate, and enabling
               // auto-conversion services.
               DataObject data = new DataObject(DataFormats.UnicodeText, (Object)textData, autoConvert);
               
               // If the data to be copied is supposed to be persisted after the application ends, 
               // then set the second parameter of SetDataObject to true.
               if(persistentData)
               {
                   // Place the persisted data on the clipboard.
                   Clipboard.SetDataObject(data, true);
               }
               else
               {
                   // Place the non-persisted data on the clipboard.
                   Clipboard.SetDataObject(data, false);
               }

               // If you keep a copy of the source data object, you can use the IsCurrent method to see if
               // the data object is still on the clipboard.
               bool isOriginalDataObject = Clipboard.IsCurrent(data);

' For this example, the data to be placed on the clipboard is a simple
' string.
Dim textData As String = "I want to put this string on the clipboard."
' The example will enable auto-conversion of data for this data object.
Dim autoConvert As Boolean = True

' Create a new data object, specifying the data format, data to encapsulate, and enabling
' auto-conversion services.
Dim data As New DataObject(DataFormats.UnicodeText, CType(textData, Object), autoConvert)

' If the data to be copied is supposed to be persisted after the application ends, 
' then set the second parameter of SetDataObject to true.
If persistentData Then
    ' Place the persisted data on the clipboard.
    Clipboard.SetDataObject(data, True)
Else
    ' Place the non-persisted data on the clipboard.
    Clipboard.SetDataObject(data, False)
End If

' If you keep a copy of the source data object, you can use the IsCurrent method to see if
' the data object is still on the clipboard.
Dim isOriginalDataObject As Boolean = Clipboard.IsCurrent(data)

注釈

DataObject は、 インターフェイスの基本的な実装を IDataObject 提供します。 IsCurrent は、前回 SetDataObject の呼び出しによってクリップボードに以前に配置されたデータ オブジェクトを決定します。

こちらもご覧ください

• GetDataObject()