Clipboard.SetData(String, Object) Метод

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Очищает буфер обмена и добавляет данные в указанном формате.

public:
 static void SetData(System::String ^ format, System::Object ^ data);

public static void SetData (string format, object data);

static member SetData : string * obj -> unit

Public Shared Sub SetData (format As String, data As Object)

Параметры

format

String

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

data

Object

Объект Object, представляющий добавляемые данные.

Исключения

ExternalException

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

ThreadStateException

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

ArgumentNullException

data имеет значение null.

Примеры

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

// 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 метод, чтобы определить, содержит ли буфер обмена данные в этом формате перед получением его с GetData помощью метода.

Примечание

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

См. также раздел

• DataFormats
• ContainsData(String)
• GetData(String)