System.Windows.Forms.IDataObject.GetDataPresent Method

Determines whether data stored in this instance is associated with the specified format, using a Boolean value to determine whether to convert the data to the format.

Syntax

public bool GetDataPresent (string format, bool autoConvert)

Parameters

format
The format for which to check. See System.Windows.Forms.DataFormats for predefined formats.
autoConvert
true to determine whether data stored in this instance can be converted to the specified format; false to check whether the data is in the specified format.

Returns

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

Remarks

Call this method to determine whether a format exists in this System.Windows.Forms.DataObject before calling IDataObject.GetData(string, bool). Call IDataObject.GetFormats(bool) for the formats that are available in this instance.

This method returns true when:

  • The autoConvert parameter is true and the data is in a format that can be converted to the appropriate format.

  • The autoConvert parameter is false and the data is in the appropriate format.

This method returns false when:

  • The autoConvert parameter is true and this method cannot find data in the specified format, and it cannot convert data to the specified format, or the data was stored with autoConvert set to false.

  • The autoConvert parameter is false, and data does not exist in this instance in the specified format.

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.

For an implementation of this method, see DataObject.GetDataPresent(Type).

Requirements

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0