Clipboard.ContainsText Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Indicates whether there is text data on the Clipboard.
Overloads
| ContainsText() |
Indicates whether there is data on the Clipboard in the Text or UnicodeText format, depending on the operating system. |
| ContainsText(TextDataFormat) |
Indicates whether there is text data on the Clipboard in the format indicated by the specified TextDataFormat value. |
ContainsText()
Indicates whether there is data on the Clipboard in the Text or UnicodeText format, depending on the operating system.
public:
static bool ContainsText();public static bool ContainsText ();static member ContainsText : unit -> boolPublic Shared Function ContainsText () As BooleanReturns
true if there is text data on the Clipboard; otherwise, false.
Exceptions
The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.
The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.
Examples
The following example demonstrates an overload of the ContainsText method that is similar to this overload.
// 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
Remarks
This method checks for the presence of data in the UnicodeText format on Windows XP Home Edition, Windows XP Professional, Windows Server 2003 and Windows 2000. Otherwise, this method checks for the presence of data in the Text format.
Use this method to determine whether the Clipboard contains text data before retrieving it with the GetText method.
Note
The Clipboard class can only be used in threads set to single thread apartment (STA) mode. To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute.
See also
Applies to
ContainsText(TextDataFormat)
Indicates whether there is text data on the Clipboard in the format indicated by the specified TextDataFormat value.
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 -> boolPublic Shared Function ContainsText (format As TextDataFormat) As BooleanParameters
- format
- TextDataFormat
One of the TextDataFormat values.
Returns
true if there is text data on the Clipboard in the value specified for format; otherwise, false.
Exceptions
The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.
The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.
format is not a valid TextDataFormat value.
Examples
The following example demonstrates this member.
// 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
Remarks
Use this method to determine whether the Clipboard contains text data before retrieving it with the GetText method.
Note
The Clipboard class can only be used in threads set to single thread apartment (STA) mode. To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute.
