ContainsData Method

Clipboard.ContainsData Method (String)

 

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)

public static bool ContainsData(
	string format
)

Parameters

format
Type: System.String

The format of the data to look for. See DataFormats for predefined formats.

Return Value

Type: System.Boolean

true 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.

System_CAPS_noteNote

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.

The following example demonstrates this member.

// 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;
}

UIPermission

for access to the system Clipboard. Associated enumeration: UIPermissionClipboard.AllClipboard

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft