IDataObject Interface

May 11, 2014

Provides a format-independent mechanism for transferring data.

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

public interface IDataObject

  NameDescription
Public methodGetData(String)Retrieves a data object in a specified format; the data format is specified by a string.
Public methodGetData(Type)Retrieves a data object in a specified format; the data format is specified by a Type object.
Public methodGetData(String, Boolean)Retrieves a data object in a specified format, and optionally, converts the data to the specified format.
Public methodGetDataPresent(String)Checks whether the data is available in, or can be converted to, a specified format; the data format is specified by a string.
Public methodGetDataPresent(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 Type object.
Public methodGetDataPresent(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.
Public methodGetFormats()Returns a list of all formats that the data in this data object is stored in, or can be converted to.
Public methodGetFormats(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.
Public methodSetData(Object)Stores the specified data in this data object, and automatically converts the data format from the source object type.
Public methodSetData(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.
Public methodSetData(Type, Object)Stores the specified data in this data object, using one or more specified data formats. The data format is specified by a Type class.
Public methodSetData(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.
Top

The API for IDataObject is documented as a general interface, just like it is documented in the equivalent WPF implementation. However, implementing the interface is not a primary Windows Phone scenario. For more information about how to retrieve the data from an IDataObject instance that is returned by Data, see the documentation for IDataObject, and also see the documentation for individual IDataObject members. The IDataObject implementation provides the behavior that is invoked whenever you retrieve the value of DragEventArgs.Data.

Important noteImportant Note:

The use of this interface in Windows Phone is limited to a particular scenario: enabling a Windows Phone UIElement to be a drop target for file list information and returning the data object as an instance of IDataObject.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Show:
© 2014 Microsoft