Clipboard.GetData(String) Metoda

Definice

Obor názvů:

System.Windows.Forms

Sestavení:

System.Windows.Forms.dll

Zdroj:

Clipboard.cs

Upozornění

Clipboard.GetData(string) method is obsolete. Use Clipboard.TryGetData<T> methods instead.

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

public:
 static System::Object ^ GetData(System::String ^ format);

[System.Obsolete("`Clipboard.GetData(string)` method is obsolete. Use `Clipboard.TryGetData<T>` methods instead.", false, DiagnosticId="WFDEV005", UrlFormat="https://aka.ms/winforms-warnings/{0}")]
public static object? GetData(string format);

[<System.Obsolete("`Clipboard.GetData(string)` method is obsolete. Use `Clipboard.TryGetData<T>` methods instead.", false, DiagnosticId="WFDEV005", UrlFormat="https://aka.ms/winforms-warnings/{0}")>]
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

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

Atributy

ObsoleteAttribute

Výjimky

ExternalException

Schránku nelze vymazat. K tomu obvykle dochází v případě, že schránku používá jiný proces.

ThreadStateException

Aktuální vlákno není v režimu STA (Single-Threaded Apartment). Přidejte metodu STAThreadAttributeMain 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

ContainsData Pomocí metody určete, 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 převést data do formátu. Pokud data nelze převést do zadaného formátu nebo pokud byla data uložena s automatickým převodem nastavena na false, tato metoda vrátí null.

Note

Data se dají převést do jiného formátu, pokud byla uložena a určuje, ž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 lze převést na text.

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

SetData Metoda slouží k přidání dat do schránky v určitém formátu.

Viz také

• Object
• DataFormats
• ContainsData(String)
• SetData(String, Object)