DataTransferExtensions Class
Definition
Contains extension methods for Avalonia.Input.IDataTransfer.
public class DataTransferExtensions
Methods
| Name | Description |
|---|---|
| Contains | Gets whether a Avalonia.Input.IDataTransfer supports a specific format. |
| GetItems | Gets the list of Avalonia.Input.IDataTransferItem contained in this object, filtered by a given format. |
| TryGetBitmap | Returns a bitmap, if available, from a Avalonia.Input.IDataTransfer instance. |
| TryGetFile | Returns a file, if available, from a Avalonia.Input.IDataTransfer instance. |
| TryGetFiles | Returns a list of files, if available, from a Avalonia.Input.IDataTransfer instance. |
| TryGetText | Returns a text, if available, from a Avalonia.Input.IDataTransfer instance. |
| TryGetValue | No summary available. |
| TryGetValues | No summary available. |
Contains Method
Gets whether a Avalonia.Input.IDataTransfer supports a specific format.
public bool Contains(Avalonia.Input.IDataTransfer dataTransfer, Avalonia.Input.DataFormat format)
Parameters
dataTransfer Avalonia.Input.IDataTransfer
The Avalonia.Input.IDataTransfer instance.
format Avalonia.Input.DataFormat
The format to check.
Returns
bool
true if format is supported, false otherwise.
GetItems Method
Gets the list of Avalonia.Input.IDataTransferItem contained in this object, filtered by a given format.
public System.Collections.Generic.IEnumerable<Avalonia.Input.IDataTransferItem> GetItems(Avalonia.Input.IDataTransfer dataTransfer, Avalonia.Input.DataFormat format)
Parameters
dataTransfer Avalonia.Input.IDataTransfer
format Avalonia.Input.DataFormat
Returns
System.Collections.Generic.IEnumerable<Avalonia.Input.IDataTransferItem>
Remarks
Some platforms (such as Windows and X11) may only support a single data item for all formats except Avalonia.Input.DataFormat.File.
Items returned by this property must stay valid until the Avalonia.Input.IDataTransfer is disposed.
TryGetBitmap Method
Returns a bitmap, if available, from a Avalonia.Input.IDataTransfer instance.
public Avalonia.Media.Imaging.Bitmap TryGetBitmap(Avalonia.Input.IDataTransfer dataTransfer)
Parameters
dataTransfer Avalonia.Input.IDataTransfer
The Avalonia.Input.IDataTransfer instance.
Returns
A Avalonia.Media.Imaging.Bitmap, or null if the format isn't available.
See also
TryGetFile Method
Returns a file, if available, from a Avalonia.Input.IDataTransfer instance.
public Avalonia.Platform.Storage.IStorageItem TryGetFile(Avalonia.Input.IDataTransfer dataTransfer)
Parameters
dataTransfer Avalonia.Input.IDataTransfer
The Avalonia.Input.IDataTransfer instance.
Returns
Avalonia.Platform.Storage.IStorageItem
An Avalonia.Platform.Storage.IStorageItem (file or folder), or null if the format isn't available.
See also
TryGetFiles Method
Returns a list of files, if available, from a Avalonia.Input.IDataTransfer instance.
public Avalonia.Platform.Storage.IStorageItem[] TryGetFiles(Avalonia.Input.IDataTransfer dataTransfer)
Parameters
dataTransfer Avalonia.Input.IDataTransfer
The Avalonia.Input.IDataTransfer instance.
Returns
Avalonia.Platform.Storage.IStorageItem[]
An array of Avalonia.Platform.Storage.IStorageItem (files or folders), or null if the format isn't available.
See also
TryGetText Method
Returns a text, if available, from a Avalonia.Input.IDataTransfer instance.
public string TryGetText(Avalonia.Input.IDataTransfer dataTransfer)
Parameters
dataTransfer Avalonia.Input.IDataTransfer
The Avalonia.Input.IDataTransfer instance.
Returns
string
A string, or null if the format isn't available.
See also
TryGetValue Method
public T TryGetValue<T>(Avalonia.Input.IDataTransfer dataTransfer, Avalonia.Input.DataFormat<T><T> format)
Parameters
dataTransfer Avalonia.Input.IDataTransfer
format Avalonia.Input.DataFormat<T><T>
Type Parameters
T
Returns
T
TryGetValues Method
public T[] TryGetValues<T>(Avalonia.Input.IDataTransfer dataTransfer, Avalonia.Input.DataFormat<T><T> format)
Parameters
dataTransfer Avalonia.Input.IDataTransfer
format Avalonia.Input.DataFormat<T><T>
Type Parameters
T
Returns
T[]