AsyncDataTransferExtensions Class
Definition
Contains extension methods for Avalonia.Input.IAsyncDataTransfer.
public class AsyncDataTransferExtensions
Methods
| Name | Description |
|---|---|
| Contains | Gets whether a Avalonia.Input.IAsyncDataTransfer supports a specific format. |
| GetItems | Gets the list of Avalonia.Input.IAsyncDataTransferItem contained in this object, filtered by a given format. |
| TryGetBitmapAsync | Returns a bitmap, if available, from a Avalonia.Input.IAsyncDataTransfer instance. |
| TryGetFileAsync | Returns a file, if available, from a Avalonia.Input.IAsyncDataTransfer instance. |
| TryGetFilesAsync | Returns a list of files, if available, from a Avalonia.Input.IAsyncDataTransfer instance. |
| TryGetTextAsync | Returns a text, if available, from a Avalonia.Input.IAsyncDataTransfer instance. |
| TryGetValueAsync | No summary available. |
| TryGetValuesAsync | No summary available. |
Contains Method
Gets whether a Avalonia.Input.IAsyncDataTransfer supports a specific format.
public bool Contains(Avalonia.Input.IAsyncDataTransfer dataTransfer, Avalonia.Input.DataFormat format)
Parameters
dataTransfer Avalonia.Input.IAsyncDataTransfer
The Avalonia.Input.IAsyncDataTransfer 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.IAsyncDataTransferItem contained in this object, filtered by a given format.
public System.Collections.Generic.IEnumerable<Avalonia.Input.IAsyncDataTransferItem> GetItems(Avalonia.Input.IAsyncDataTransfer dataTransfer, Avalonia.Input.DataFormat format)
Parameters
dataTransfer Avalonia.Input.IAsyncDataTransfer
format Avalonia.Input.DataFormat
Returns
System.Collections.Generic.IEnumerable<Avalonia.Input.IAsyncDataTransferItem>
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.IAsyncDataTransfer is disposed.
TryGetBitmapAsync Method
Returns a bitmap, if available, from a Avalonia.Input.IAsyncDataTransfer instance.
public System.Threading.Tasks.Task<Avalonia.Media.Imaging.Bitmap> TryGetBitmapAsync(Avalonia.Input.IAsyncDataTransfer dataTransfer)
Parameters
dataTransfer Avalonia.Input.IAsyncDataTransfer
The Avalonia.Input.IAsyncDataTransfer instance.
Returns
System.Threading.Tasks.Task<Avalonia.Media.Imaging.Bitmap>
A Avalonia.Media.Imaging.Bitmap, or null if the format isn't available.
See also
TryGetFileAsync Method
Returns a file, if available, from a Avalonia.Input.IAsyncDataTransfer instance.
public System.Threading.Tasks.Task<Avalonia.Platform.Storage.IStorageItem> TryGetFileAsync(Avalonia.Input.IAsyncDataTransfer dataTransfer)
Parameters
dataTransfer Avalonia.Input.IAsyncDataTransfer
The Avalonia.Input.IAsyncDataTransfer instance.
Returns
System.Threading.Tasks.Task<Avalonia.Platform.Storage.IStorageItem>
An Avalonia.Platform.Storage.IStorageItem (file or folder), or null if the format isn't available.
See also
TryGetFilesAsync Method
Returns a list of files, if available, from a Avalonia.Input.IAsyncDataTransfer instance.
public System.Threading.Tasks.Task<Avalonia.Platform.Storage.IStorageItem[]> TryGetFilesAsync(Avalonia.Input.IAsyncDataTransfer dataTransfer)
Parameters
dataTransfer Avalonia.Input.IAsyncDataTransfer
The Avalonia.Input.IAsyncDataTransfer instance.
Returns
System.Threading.Tasks.Task<Avalonia.Platform.Storage.IStorageItem[]>
An array of Avalonia.Platform.Storage.IStorageItem (files or folders), or null if the format isn't available.
See also
TryGetTextAsync Method
Returns a text, if available, from a Avalonia.Input.IAsyncDataTransfer instance.
public System.Threading.Tasks.Task<string> TryGetTextAsync(Avalonia.Input.IAsyncDataTransfer dataTransfer)
Parameters
dataTransfer Avalonia.Input.IAsyncDataTransfer
The Avalonia.Input.IAsyncDataTransfer instance.
Returns
System.Threading.Tasks.Task<string>
A string, or null if the format isn't available.
See also
TryGetValueAsync Method
public System.Threading.Tasks.Task<T> TryGetValueAsync<T>(Avalonia.Input.IAsyncDataTransfer dataTransfer, Avalonia.Input.DataFormat<T><T> format)
Parameters
dataTransfer Avalonia.Input.IAsyncDataTransfer
format Avalonia.Input.DataFormat<T><T>
Type Parameters
T
Returns
System.Threading.Tasks.Task<T>
TryGetValuesAsync Method
public System.Threading.Tasks.Task<T[]> TryGetValuesAsync<T>(Avalonia.Input.IAsyncDataTransfer dataTransfer, Avalonia.Input.DataFormat<T><T> format)
Parameters
dataTransfer Avalonia.Input.IAsyncDataTransfer
format Avalonia.Input.DataFormat<T><T>
Type Parameters
T
Returns
System.Threading.Tasks.Task<T[]>