Clipboard.GetData(String) Methode

  • Referenz

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Ruft Daten im angegebenen Format aus der Zwischenablage ab.

public:
 static System::Object ^ GetData(System::String ^ format);
public static object GetData (string format);
public static object? GetData (string format);
static member GetData : string -> obj
Public Shared Function GetData (format As String) As Object

Parameter

format
String

Das Format der abzurufenden Daten. Vordefinierte Formate finden Sie unter DataFormats.

Gibt zurück

Object

Ein Object, das die Daten in der Zwischenablage darstellt, oder null, wenn die Zwischenablage keine Daten im angegebenen format oder keine Daten enthält, die in dieses Format konvertiert werden können.

Ausnahmen

ExternalException

Die Zwischenablage konnte nicht gelöscht werden. Dies tritt i. d. R. auf, wenn die Zwischenablage von einem anderen Prozess verwendet wird.

ThreadStateException

Der aktuelle Thread befindet sich nicht im STA-Modus (Singlethread-Apartment). Fügen Sie der Main-Methode der Anwendung das STAThreadAttribute hinzu.

Beispiele

Im folgenden Beispiel wird dieses Element veranschaulicht.

// Demonstrates SetData, ContainsData, and GetData.
public Object SwapClipboardFormattedData(String format, Object data)
{
    Object returnObject = null;
    if (Clipboard.ContainsData(format))
    {
        returnObject = Clipboard.GetData(format);
        Clipboard.SetData(format, data);
    }
    return returnObject;
}

' Demonstrates SetData, ContainsData, and GetData.
Public Function SwapClipboardFormattedData( _
    ByVal format As String, ByVal data As Object) As Object

    Dim returnObject As Object = Nothing

    If (Clipboard.ContainsData(format)) Then
        returnObject = Clipboard.GetData(format)
        Clipboard.SetData(format, data)
    End If

    Return returnObject

End Function

Hinweise

Verwenden Sie die ContainsData Methode, um zu bestimmen, ob die Zwischenablage Daten im angegebenen Format oder einem kompatiblen Format enthält, bevor Sie sie mit dieser Methode abrufen.

Wenn diese Methode daten im angegebenen Format nicht finden kann, versucht sie, die Daten in das Format zu konvertieren. Wenn die Daten nicht in das angegebene Format konvertiert werden können oder wenn die Daten mit der automatischen Konvertierung falseauf gespeichert wurden, gibt diese Methode zurück null.

Hinweis

Daten können in ein anderes Format konvertiert werden, wenn die Konvertierung zulässig ist, und wenn das angeforderte Format mit dem gespeicherten Format kompatibel ist. Beispielsweise können Daten, die als Unicode gespeichert werden, in Text konvertiert werden.

Die Clipboard Klasse kann nur im Thread-Modus (Single Thread Apartment, STA) verwendet werden. Um diese Klasse zu verwenden, stellen Sie sicher, dass Ihre Main Methode mit dem STAThreadAttribute Attribut gekennzeichnet ist.

Verwenden Sie die SetData Methode zum Hinzufügen von Daten zur Zwischenablage in einem bestimmten Format.

Gilt für

Siehe auch