IDataObject Interface
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Provides a format-independent mechanism for transferring data.
Namespace: System.Windows
Assembly: System.Windows (in System.Windows.dll)
Syntax
'Declaration
Public Interface IDataObject
public interface IDataObject
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") .gif "Supported by Silverlight for Windows Phone") |
GetData(String) | Retrieves a data object in a specified format; the data format is specified by a string. |
|
GetData(Type) | Retrieves a data object in a specified format; the data format is specified by a Type object. |
|
GetData(String, Boolean) | Retrieves a data object in a specified format, and optionally, converts the data to 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. |
|
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 Type object. |
|
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. |
|
GetFormats() | Returns a list of all formats that the data in this data object is stored in, or can be converted to. |
|
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. |
|
SetData(Object) | Stores the specified data in this data object, and automatically converts the data format from the source object type. |
|
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. |
|
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 Type class. |
|
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. |
Top
Remarks
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 Silverlight 5 scenario. For more information about how to retrieve the data from an IDataObject instance that is returned by Data, see the documentation for DataObject, and also see the documentation for individual DataObject members. The DataObject implementation provides the behavior that is invoked whenever you retrieve the value of DragEventArgs.Data.
.gif "Important note") Important Note: |
|---|
The use of this interface in Silverlight 5 is limited to a particular scenario: enabling a Silverlight 5 UIElement to be a drop target for file list information and returning the data object as an instance of IDataObject. |
Version Information
Silverlight
Supported in: 5, 4
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.