Clipboard.GetData(String) Метод

Ссылка

Определение

Пространство имен:: System.Windows.Forms

Сборка:: System.Windows.Forms.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Извлекает данные из буфера обмена в указанном формате.

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

Параметры

format: String

Формат извлекаемых данных. Сведения о предварительно определенных форматах см. в разделе DataFormats.

Возвращаемое значение

Object

Объект Object, представляющий данные буфера обмена, или значение null, если буфер обмена не содержит никаких данных в формате format или данных, которые могут быть преобразованы в этот формат.

Исключения

ExternalException

Не удалось очистить буфер обмена. Обычно это происходит, когда буфер обмена используется другим процессом.

ThreadStateException

Текущий поток не выполняется в режиме апартмента с одним потоком (STA). Добавьте STAThreadAttribute в метод Main своего приложения.

Примеры

В следующем примере демонстрируется этот элемент.

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

Используйте метод, ContainsData чтобы определить, содержит ли буфер обмена данные в указанном формате или совместимом формате, прежде чем получить его с помощью этого метода.

Если этот метод не может найти данные в указанном формате, он пытается преобразовать данные в формат. Если данные не могут быть преобразованы в указанный формат или данные были сохранены с автоматическим falseпреобразованием, возвращается nullэтот метод.

Примечание

Данные можно преобразовать в другой формат, если он был сохранен, указав, что преобразование разрешено, и если запрошенный формат совместим с сохраненным форматом. Например, данные, хранящиеся в Юникоде, можно преобразовать в текст.

Класс Clipboard можно использовать только в потоках, для работы в режиме однопотокового подразделения (STA). Чтобы использовать этот класс, убедитесь, что Main метод помечен атрибутом STAThreadAttribute .

SetData Используйте метод для добавления данных в буфер обмена в определенном формате.

Применяется к