Sdílet prostřednictvím

Clipboard.GetData(String) Metoda

  • Reference

Definice

Obor názvů:
System.Windows.Forms
Sestavení:
System.Windows.Forms.dll

Načte data ze schránky v zadaném formátu.

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

Formát dat, která se mají načíst. Viz DataFormats předdefinované formáty.

Návraty

Object

Reprezentace Object dat schránky nebo null pokud schránka neobsahuje žádná data, která jsou v zadaném format nebo lze převést na tento formát.

Výjimky

ExternalException

Schránku nelze vymazat. K tomu obvykle dochází, když je schránka používána jiným procesem.

ThreadStateException

Aktuální vlákno není v režimu STA (single-threaded apartment). Přidejte metodu STAThreadAttribute Main aplikace.

Příklady

Následující příklad ukazuje tohoto člena.

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

Poznámky

Použijte metodu ContainsData k určení, zda schránka obsahuje data v zadaném formátu nebo kompatibilní formát před načtením pomocí této metody.

Pokud tato metoda nemůže najít data v zadaném formátu, pokusí se data převést do formátu. Pokud nelze data převést na zadaný formát nebo pokud byla data uložena s automatickým převodem nastavena na false, tato metoda vrátí null.

Poznámka

Data je možné převést do jiného formátu, pokud byla uložena určení, že převod je povolený, a pokud je požadovaný formát kompatibilní s uloženým formátem. Například data uložená jako Unicode se dají převést na text.

Třída Clipboard se dá použít pouze ve vláknech nastavených na režim STA (Single Thread Apartment). Chcete-li tuto třídu použít, ujistěte se, že je vaše Main metoda označena atributem STAThreadAttribute .

Použijte metodu SetData pro přidání dat do schránky v určitém formátu.

Platí pro

Viz také