Clipboard.GetData(String) Metode

Definisi

Ruang nama:

System.Windows.Forms

Rakitan:

System.Windows.Forms.dll

Sumber:

Clipboard.cs

Perhatian

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

Mengambil data dari Clipboard dalam format yang ditentukan.

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

Parameter

format

String

Format data yang akan diambil. Lihat DataFormats untuk format yang telah ditentukan sebelumnya.

Mengembalikan

Object

Mewakili Object data Clipboard atau null jika Clipboard tidak berisi data apa pun yang ada dalam yang ditentukan format atau dapat dikonversi ke format tersebut.

Atribut

ObsoleteAttribute

Pengecualian

ExternalException

Papan klip tidak dapat dibersihkan. Ini biasanya terjadi ketika Clipboard sedang digunakan oleh proses lain.

ThreadStateException

Utas saat ini tidak dalam mode apartemen berulir tunggal (STA). Tambahkan ke STAThreadAttribute metode aplikasi Main Anda.

Contoh

Contoh berikut menunjukkan anggota ini.

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

Keterangan

ContainsData Gunakan metode untuk menentukan apakah Clipboard berisi data dalam format yang ditentukan atau format yang kompatibel sebelum mengambilnya dengan metode ini.

Jika metode ini tidak dapat menemukan data dalam format yang ditentukan, metode ini mencoba mengonversi data ke format . Jika data tidak dapat dikonversi ke format yang ditentukan, atau jika data disimpan dengan konversi otomatis diatur ke false, metode ini mengembalikan null.

Note

Data dapat dikonversi ke format lain jika disimpan yang menentukan bahwa konversi diizinkan, dan jika format yang diminta kompatibel dengan format tersimpan. Misalnya, data yang disimpan sebagai Unicode dapat dikonversi ke teks.

Kelas Clipboard hanya dapat digunakan dalam utas yang disetel ke mode apartemen utas tunggal (STA). Untuk menggunakan kelas ini, pastikan bahwa metode Main Anda ditandai dengan atribut STAThreadAttribute.

SetData Gunakan metode untuk menambahkan data ke Clipboard dalam format tertentu.

Lihat juga

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