This topic has not yet been rated - Rate this topic

Clipboard.ContainsData Method

.NET Framework 4

Other Versions

Queries the Clipboard for the presence of data in a specified data format.

Namespace: System.Windows
Assembly: PresentationCore (in PresentationCore.dll)

Syntax

C++

Copy

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 data in the specified format is available on the Clipboard; otherwise, false. See Remarks.

Exceptions

Exception	Condition
ArgumentNullException	format is null.

Remarks

A query for the data format Bitmap or FileDrop will return true if the data can be automatically converted to the specified data format. For other data formats, this method returns true only if the specified format is available natively on the Clipboard.

Examples

The following example demonstrates the use of this method.

Copy



                // After this line executes, IsHTMLDataOnClipboard will be true if
                // HTML data is available natively on the clipboard; if not, it 
                // will be false.
                bool IsHTMLDataOnClipboard = Clipboard.ContainsData(DataFormats.Html);

                // If there is HTML data on the clipboard, retrieve it.
                string htmlData;
                if(IsHTMLDataOnClipboard)
                {

                    htmlData = Clipboard.GetText(TextDataFormat.Html);

                }

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Clipboard Class

System.Windows Namespace

ContainsAudio

ContainsFileDropList

ContainsImage

ContainsText

GetData

SetData

DataFormats

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ