Clipboard.SetDataObject Metod

Definition

Namnområde:
System.Windows
Sammansättning:
PresentationCore.dll

Lagrar ett angivet dataobjekt i systemets Urklipp.

Överlagringar

Name Description
SetDataObject(Object)

Placerar ett angivet icke-beständigt dataobjekt i systemets Urklipp.
SetDataObject(Object, Boolean)

Placerar ett angivet dataobjekt i systemets Urklipp och accepterar en boolesk parameter som anger om dataobjektet ska lämnas kvar i Urklipp när programmet avslutas.

SetDataObject(Object)

Placerar ett angivet icke-beständigt dataobjekt i systemets Urklipp.

public:
 static void SetDataObject(System::Object ^ data);
[System.Security.SecurityCritical]
public static void SetDataObject(object data);
public static void SetDataObject(object data);
[<System.Security.SecurityCritical>]
static member SetDataObject : obj -> unit
static member SetDataObject : obj -> unit
Public Shared Sub SetDataObject (data As Object)

Parametrar

data
Object

Ett dataobjekt (ett objekt som implementerar IDataObject) att placera på urklipp i systemet.

Attribut
SecurityCriticalAttribute

Undantag

ArgumentNullException

data är null.

ExternalException

Ett fel uppstod vid åtkomst till Urklipp. Undantagsinformationen innehåller en HResult som identifierar det specifika felet. Se ErrorCode.

Kommentarer

Som standard rensas data som placeras i systemets Urklipp med SetDataObject automatiskt från Urklipp när programmet avslutas.

Note

Standardbeteendet för att rensa Urklipp vid programavslut kan skilja sig från andra implementeringar, vilket kan lämna data i Urklipp vid programavslut i stället för att rensa det som standard. Använd överlagringen SetDataObject och ange parametern copy som true om du inte vill att data ska rensas från Urklipp när programmet avslutas.

DataObject tillhandahåller en grundläggande implementering av IDataObject gränssnittet.

Se även

Gäller för

SetDataObject(Object, Boolean)

Placerar ett angivet dataobjekt i systemets Urklipp och accepterar en boolesk parameter som anger om dataobjektet ska lämnas kvar i Urklipp när programmet avslutas.

public:
 static void SetDataObject(System::Object ^ data, bool copy);
[System.Security.SecurityCritical]
public static void SetDataObject(object data, bool copy);
public static void SetDataObject(object data, bool copy);
[<System.Security.SecurityCritical>]
static member SetDataObject : obj * bool -> unit
static member SetDataObject : obj * bool -> unit
Public Shared Sub SetDataObject (data As Object, copy As Boolean)

Parametrar

data
Object

Ett dataobjekt (ett objekt som implementerar IDataObject) att placera på urklipp i systemet.

copy
Boolean

true för att lämna data på systemurklippet när programmet avslutas; false för att rensa data från systemets Urklipp när programmet avslutas.

Attribut
SecurityCriticalAttribute

Undantag

ArgumentNullException

data är null.

ExternalException

Ett fel uppstod vid åtkomst till Urklipp. Undantagsinformationen innehåller en HResult som identifierar det specifika felet. Se ErrorCode.

Exempel

I följande exempel visas användningen av den här metoden.


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

Kommentarer

DataObject tillhandahåller en grundläggande implementering av IDataObject gränssnittet. IsCurrent avgör dataobjektet som tidigare placerats i Urklipp av det senaste SetDataObject anropet.

Se även

Gäller för