Clipboard.GetData(String) Metoda

Definicja

Pobiera dane ze Schowka w określonym formacie.

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

Parametry

format
String

Format danych do pobrania. Zobacz DataFormats , aby zapoznać się ze wstępnie zdefiniowanymi formatami.

Zwraca

Object

Reprezentujący Object dane Schowka lub null jeśli Schowek nie zawiera żadnych danych, które znajdują się w określonym format formacie lub można je przekonwertować na ten format.

Wyjątki

Nie można wyczyścić Schowka. Zwykle dzieje się tak, gdy Schowek jest używany przez inny proces.

Bieżący wątek nie jest w trybie jednowątkowy (STA). Dodaj element STAThreadAttribute do metody aplikacji Main .

Przykłady

W poniższym przykładzie pokazano ten element członkowski.

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

Uwagi

ContainsData Użyj metody , aby określić, czy Schowek zawiera dane w określonym formacie, czy zgodnym formacie przed pobraniem go za pomocą tej metody.

Jeśli ta metoda nie może odnaleźć danych w określonym formacie, próbuje przekonwertować dane na format. Jeśli nie można przekonwertować danych na określony format lub jeśli dane były przechowywane z automatycznym zestawem konwersji na falsewartość , ta metoda zwraca wartość null.

Uwaga

Dane można przekonwertować na inny format, jeśli zostały zapisane, określając, że konwersja jest dozwolona, a żądany format jest zgodny z zapisanym formatem. Na przykład dane przechowywane jako Unicode można przekonwertować na tekst.

Klasę Clipboard można używać tylko w wątkach ustawionych na tryb apartamentów pojedynczego wątku (STA). Aby użyć tej klasy, upewnij się, że metoda Main jest oznaczona atrybutem STAThreadAttribute .

SetData Użyj metody , aby dodać dane do Schowka w określonym formacie.

Dotyczy

Zobacz też