Clipboard.ContainsData(String) 方法

定义

指示剪贴板中是否存在指定格式的数据,或可转换成此格式的数据。

public:
 static bool ContainsData(System::String ^ format);
public static bool ContainsData (string format);
public static bool ContainsData (string? format);
static member ContainsData : string -> bool
Public Shared Function ContainsData (format As String) As Boolean

参数

format
String

要查找的数据格式。 请参见 DataFormats 以获取预定义的格式。

返回

如果在剪贴板中存在指定 format 或可以转换成该格式的数据,则为 true;否则为 false

例外

未能清空剪贴板。 这种情况通常发生在剪贴板正在被其他进程使用的时候。

当前线程未处于单线程单元 (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

注解

DataFormats 包含可用于此方法的预定义格式名称。

在使用 方法检索 GetData 数据之前,使用此方法确定剪贴板是包含指定格式的数据还是兼容格式的数据。

注意

如果存储数据时指定允许转换,并且请求的格式与存储的格式兼容,则可以将数据转换为另一种格式。 例如,存储为 Unicode 的数据可以转换为文本。

Clipboard 类只能在设置为单线程单元 (STA) 模式的线程中使用。 若要使用此类,请确保使用 Main 特性标记 STAThreadAttribute 方法。

适用于

另请参阅