Clipboard.ContainsText 方法

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

指示剪贴板中是否存在文本数据。

重载

ContainsText()	指示剪贴板中是否存在 Text 或 UnicodeText 格式的数据（取决于操作系统）。
ContainsText(TextDataFormat)	指示剪贴板中是否存在具有指定的 TextDataFormat 值所指示的格式的文本数据。

ContainsText()

指示剪贴板中是否存在 Text 或 UnicodeText 格式的数据（取决于操作系统）。

public:
 static bool ContainsText();

public static bool ContainsText ();

static member ContainsText : unit -> bool

Public Shared Function ContainsText () As Boolean

返回

Boolean

如果剪贴板中存在文本数据，则为 true；否则为，false。

例外

ExternalException

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

ThreadStateException

当前线程未处于单线程单元 (STA) 模式下。 请将 STAThreadAttribute 添加到应用程序的 Main 方法中。

示例

下面的示例演示了类似于此重载的方法的 ContainsText 重载。

// Demonstrates SetText, ContainsText, and GetText.
public String SwapClipboardHtmlText(String replacementHtmlText)
{
    String returnHtmlText = null;
    if (Clipboard.ContainsText(TextDataFormat.Html))
    {
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html);
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html);
    }
    return returnHtmlText;
}

' Demonstrates SetText, ContainsText, and GetText.
Public Function SwapClipboardHtmlText( _
    ByVal replacementHtmlText As String) As String

    Dim returnHtmlText As String = Nothing

    If (Clipboard.ContainsText(TextDataFormat.Html)) Then
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html)
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html)
    End If

    Return returnHtmlText

End Function

注解

此方法检查 Windows XP Home Edition、Windows XP Professional、Windows Server 2003 和 Windows 2000 上是否存在数据UnicodeText。 否则，此方法将检查格式中的数据 Text 是否存在。

使用此方法来确定剪贴板是否包含文本数据，然后再使用 GetText 该方法检索数据。

备注

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

另请参阅

• TextDataFormat
• Text
• UnicodeText
• GetText
• SetText

ContainsText(TextDataFormat)

指示剪贴板中是否存在具有指定的 TextDataFormat 值所指示的格式的文本数据。

public:
 static bool ContainsText(System::Windows::Forms::TextDataFormat format);

public static bool ContainsText (System.Windows.Forms.TextDataFormat format);

static member ContainsText : System.Windows.Forms.TextDataFormat -> bool

Public Shared Function ContainsText (format As TextDataFormat) As Boolean

参数

format

TextDataFormat

TextDataFormat 值之一。

返回

Boolean

如果剪贴板中存在格式值为指定 format 的文本数据，则为 true；否则为 false。

例外

ExternalException

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

ThreadStateException

当前线程未处于单线程单元 (STA) 模式下。 请将 STAThreadAttribute 添加到应用程序的 Main 方法中。

InvalidEnumArgumentException

format 不是有效的 TextDataFormat 值。

示例

以下示例演示此成员。

// Demonstrates SetText, ContainsText, and GetText.
public String SwapClipboardHtmlText(String replacementHtmlText)
{
    String returnHtmlText = null;
    if (Clipboard.ContainsText(TextDataFormat.Html))
    {
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html);
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html);
    }
    return returnHtmlText;
}

' Demonstrates SetText, ContainsText, and GetText.
Public Function SwapClipboardHtmlText( _
    ByVal replacementHtmlText As String) As String

    Dim returnHtmlText As String = Nothing

    If (Clipboard.ContainsText(TextDataFormat.Html)) Then
        returnHtmlText = Clipboard.GetText(TextDataFormat.Html)
        Clipboard.SetText(replacementHtmlText, TextDataFormat.Html)
    End If

    Return returnHtmlText

End Function

注解

使用此方法来确定剪贴板是否包含文本数据，然后再使用 GetText 该方法检索数据。

备注

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

另请参阅

• TextDataFormat
• GetText
• SetText