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)