Interface IDataObject

Provides a format-independent mechanism for transferring data.

Namespace: System.Windows

Assembly: OpenSilver.dll

Syntax

public interface IDataObject

Methods

GetData(String)

Retrieves a data object in a specified format; the data format is specified by a string.

Declaration

object GetData(string format)

Parameters

Type	Name	Description
System.String	format	A string that specifies the format in which to retrieve the data. See the DataFormats class for a set of predefined data formats.

Returns

Type	Description
System.Object	A data object that has the data in the specified format; or null, if the data is not available in the specified format.

GetData(String, Boolean)

Retrieves a data object in a specified format, and optionally, converts the data to the specified format.

Declaration

object GetData(string format, bool autoConvert)

Parameters

Type	Name	Description
System.String	format	A string that specifies the format in which to retrieve the data. See the DataFormats class for a set of predefined data formats.
System.Boolean	autoConvert	true to attempt to automatically convert the data to the specified format; false to perform no data format conversion.If this parameter is false, the method returns data in the specified format if it is available; or returns null if the data is not available in the specified format.

Returns

Type	Description
System.Object	A data object that has the data in the specified format; or null, if the data is not available in the specified format.

GetData(Type)

Retrieves a data object in a specified format; the data format is specified by a System.Type object.

Declaration

object GetData(Type format)

Parameters

Type	Name	Description
System.Type	format	A System.Type object that specifies the format in which to retrieve the data. See the DataFormats class for a set of predefined data formats.

Returns

Type	Description
System.Object	A data object that has the data in the specified format; or null, if the data is not available in the specified format.

GetDataPresent(String)

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

Declaration

bool GetDataPresent(string format)

Parameters

Type	Name	Description
System.String	format	A string that specifies the format to check for. See the DataFormats class for a set of predefined data formats.

Returns

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

GetDataPresent(String, Boolean)

Checks whether the data is available in, or can be converted to, a specified format. If the data is not already available in the specified format, a Boolean flag indicates whether to check if the data can be converted to the specified format.

Declaration

bool GetDataPresent(string format, bool autoConvert)

Parameters

Type	Name	Description
System.String	format	A string that specifies the format to check for. See the DataFormats class for a set of predefined data formats.
System.Boolean	autoConvert	false to only check for the specified format; true to also check whether the data that is stored in this data object can be converted to the specified format.

Returns

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

GetDataPresent(Type)

Checks to see whether the data is available in, or can be converted to, a specified format. The data format is specified by a System.Type object.

Declaration

bool GetDataPresent(Type format)

Parameters

Type	Name	Description
System.Type	format	A System.Type that specifies the format to check for.

Returns

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

GetFormats()

Returns a list of all formats that the data in this data object is stored in, or can be converted to.

Declaration

string[] GetFormats()

Returns

Type	Description
System.String[]	An array of strings, with each string specifying the name of a format that is supported by this data object.

GetFormats(Boolean)

Returns a list of all formats that the data in this data object is stored in. A Boolean flag indicates whether to also include formats that the data can be automatically converted to.

Declaration

string[] GetFormats(bool autoConvert)

Parameters

Type	Name	Description
System.Boolean	autoConvert	true to retrieve all formats that the data in this data object is stored in, or can be converted to; false to retrieve only the formats in which the data in this data object is stored (excludes formats that the data is not stored in, but can be automatically converted to).

Returns

Type	Description
System.String[]	An array of strings, with each string specifying the name of a format that is supported by this data object.

SetData(Object)

Stores the specified data in this data object, and automatically converts the data format from the source object type.

Declaration

void SetData(object data)

Parameters

Type	Name	Description
System.Object	data	The data to store in this data object.

SetData(String, Object)

Stores the specified data in this data object, using one or more specified data formats. The data format is specified by a string.

Declaration

void SetData(string format, object data)

Parameters

Type	Name	Description
System.String	format	A string that specifies the format in which to store the data. See the DataFormats class for a set of predefined data formats.
System.Object	data	The data to store in this data object.

SetData(String, Object, Boolean)

Stores the specified data in this data object, using one or more specified data formats. This overload includes a Boolean flag to indicate whether the data may be converted to another format on retrieval.

Declaration

void SetData(string format, object data, bool autoConvert)

Parameters

Type	Name	Description
System.String	format	A string that specifies the format in which to store the data. See the DataFormats class for a set of predefined data formats.
System.Object	data	The data to store in this data object.
System.Boolean	autoConvert	true to allow the data to be converted to another format on retrieval; false to prohibit the data from being converted to another format on retrieval.

SetData(Type, Object)

Stores the specified data in this data object, using one or more specified data formats. The data format is specified by a System.Type class.

Declaration

void SetData(Type format, object data)

Parameters

Type	Name	Description
System.Type	format	A System.Type that specifies the format in which to store the data.
System.Object	data	The data to store in this data object.