IDragPayload
Provides a format independent mechanism for transferring data.
Definition
Namespace:Telerik.Windows.DragDrop.Behaviors
Assembly:Telerik.Windows.Controls.dll
Syntax:
public interface IDragPayloadProperties
Gets a IDataConverter for providing additional formats the data to be converted to.
DataConverter DataConverter { get; }Methods
Retrieves a data object in a specified format, and optionally, converts the data to the specified format.
object GetData(string format, bool autoConvert)A string that specifies the format in which to retrieve the data. See the class for a set of predefined data formats.
autoConvertboolTrue 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:A data object that has the data in the specified format; or null, if the data is not available in the specified format.
Retrieves a data object in a specified format; the data format is specified by a string.
object GetData(string format)A string that specifies the format in which to retrieve the data. See the class for a set of predefined data formats.
Returns:A data object that has the data in the specified format; or null, if the data is not available in the specified format.
Retrieves a data object in a specified format; the data format is specified by a Type object.
object GetData(Type format)A Type object that specifies the format in which to retrieve the data. See the class for a set of predefined data formats.
Returns:A data object that has the data in the specified format; or null, if the data is not available in the specified format.
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.
bool GetDataPresent(string format, bool autoConvert)A string that specifies the format to check for. See the class for a set of predefined data formats.
autoConvertboolFalse 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:True if the data is in, or can be converted to, the specified format; otherwise, false.
Checks whether the data is available in, or can be converted to, a specified format; the data format is specified by a string.
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.
Returns a list of all formats that the data in this data object is stored in, or can be converted to.
string[] GetFormats()string[]
An array of strings, with each string specifying the name of a format that is supported by this data object.
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.
string[] GetFormats(bool 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:string[]
An array of strings, with each string specifying the name of a format that is supported by this data object.
Stores the specified data in this data object, and automatically converts the data format from the source object type.
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.
void SetData(string format, object data, bool autoConvert)A string that specifies the format in which to store the data. See the class for a set of predefined data formats.
dataobjectThe data to store in this data object.
autoConvertboolTrue 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.
Stores the specified data in this data object, using one or more specified data formats. The data format is specified by a string.
Stores the specified data in this data object, using one or more specified data formats. The data format is specified by a Type class.