Clipboard.ContainsData Method
Indicates whether there is data on the Clipboard that is in the specified format or can be converted to that format.
Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Parameters
- format
- Type: System.String
The format of the data to look for. See DataFormats for predefined formats.
Return Value
Type: System.Booleantrue if there is data on the Clipboard that is in the specified format or can be converted to that format; otherwise, false.
| Exception | Condition |
|---|---|
| ExternalException | The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process. |
| ThreadStateException | The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method. |
The DataFormats class contains pre-defined format names that you can use with this method.
Use this method to determine whether the Clipboard contains data in the specified format or a compatible format before retrieving it with the GetData method.
Note |
|---|
Data can be converted to another format if it was stored specifying that conversion is allowed, and if the requested format is compatible with the stored format. For example, data stored as Unicode can be converted to text. 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. |
- UIPermission
for access to the system Clipboard. Associated enumeration: UIPermissionClipboard.AllClipboard
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note