This documentation is archived and is not being maintained.

DataObject.GetDataPresent Method (String)

Determines whether the data is available in, or can be converted to, a format specified by a string.

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

public bool GetDataPresent(
	string format
)
You cannot use methods in XAML.

Parameters

format
Type: System.String

A string that specifies the format for the data. For a set of predefined data formats, see the DataFormats class.

Return Value

Type: System.Boolean

true if the data is in, or can be converted to, the specified format; otherwise, false.

Implements

IDataObject.GetDataPresent(String)

ExceptionCondition
ArgumentNullException

format is null.

Call GetDataPresent to determine whether a format is available in this data object before calling GetData. Call GetFormats to obtain a list of all the formats that are available in this data object.

The following example uses this method to query for the presence of a particular data format by descriptor string.

DataObject dataObject = new DataObject("Some string data to store...");

// Query for the presence of Text data in the data object, by a data format descriptor string. 
// In this overload of GetDataPresent, the method will return true both for native data formats 
// and when the data can automatically be converted to the specifed format. 

// In this case, string data is present natively, so GetDataPresent returns false.
string textData = null;
if (dataObject.GetDataPresent(DataFormats.StringFormat))
{
    textData = dataObject.GetData(DataFormats.StringFormat) as string;
}

// In this case, the Text data in the data object can be autoconverted to  
// Unicode text, so GetDataPresent returns "true".
byte[] unicodeData = null;
if (dataObject.GetDataPresent(DataFormats.UnicodeText))
{
    unicodeData = dataObject.GetData(DataFormats.UnicodeText) as byte[];
}

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5, 3.0
Show: