Clipboard.SetDataObject Metoda

Definice

Obor názvů:

System.Windows

Sestavení:

PresentationCore.dll

Uloží zadaný datový objekt do systémové schránky.

Přetížení

SetDataObject(Object)	Umístí zadaný datový objekt, který není trvalý, do systémové schránky.
SetDataObject(Object, Boolean)	Umístí zadaný datový objekt do systémové schránky a přijme logický parametr, který označuje, zda má být datový objekt ponechán ve schránce při ukončení aplikace.

SetDataObject(Object)

Umístí zadaný datový objekt, který není trvalý, do systémové schránky.

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)

Parametry

data

Object

Datový objekt (objekt, který implementuje IDataObject), který se má umístit do systémové schránky.

Výjimky

ArgumentNullException

data je null.

ExternalException

Při přístupu ke schránce došlo k chybě. Podrobnosti o výjimce HResult budou obsahovat kód, který identifikuje konkrétní chybu. Viz ErrorCode.

Poznámky

Ve výchozím nastavení se data umístěná ve schránce SetDataObject systému automaticky vymažou ze schránky při ukončení aplikace.

Poznámka

Výchozí chování vymazání schránky při ukončení aplikace se může lišit od jiných implementací, což může ponechat data ve schránce při ukončení aplikace místo jejich vymazání ve výchozím nastavení. SetDataObject Použijte přetížení a zadejte copy parametr, jako true byste při ukončení aplikace nechtěli vymazat data ze schránky.

DataObject poskytuje základní implementaci IDataObject rozhraní.

Viz také

• GetDataObject()

SetDataObject(Object, Boolean)

Umístí zadaný datový objekt do systémové schránky a přijme logický parametr, který označuje, zda má být datový objekt ponechán ve schránce při ukončení aplikace.

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)

Parametry

data

Object

Datový objekt (objekt, který implementuje IDataObject), který se má umístit do systémové schránky.

copy

Boolean

true ponechat data v systémové schránce při ukončení aplikace; false vymažete data ze schránky systému při ukončení aplikace.

Výjimky

ArgumentNullException

data je null.

ExternalException

Při přístupu ke schránce došlo k chybě. Podrobnosti o výjimce HResult budou obsahovat kód, který identifikuje konkrétní chybu. Viz ErrorCode.

Příklady

Následující příklad ukazuje použití této metody.

               // 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)

Poznámky

DataObject poskytuje základní implementaci IDataObject rozhraní. IsCurrent určuje datový objekt, který byl dříve umístěn do schránky při posledním SetDataObject volání.

Viz také

• GetDataObject()