Table of Contents

Class DataObjectExtensions

Namespace
CarinaStudio.Input
Assembly
CarinaStudio.AppBase.Avalonia.dll

Extensions for Avalonia.Input.IDataObject.

public static class DataObjectExtensions
Inheritance
DataObjectExtensions
Inherited Members

Methods

Clone(IDataObject)

Clone Avalonia.Input.IDataObject as Avalonia.Input.DataObject.

[Obsolete("Use TryClone() instead.")]
public static DataObject Clone(this IDataObject data)

Parameters

data IDataObject

Avalonia.Input.IDataObject.

Returns

DataObject

Avalonia.Input.DataObject.

HasFileNames(IDataObject)

Check whether at least one file name is contained in Avalonia.Input.IDataObject or not.

public static bool HasFileNames(this IDataObject data)

Parameters

data IDataObject

Avalonia.Input.IDataObject.

Returns

bool

True if at least one file name is contained in Avalonia.Input.IDataObject.

TryClone(IDataObject, out DataObject?)

Try cloning Avalonia.Input.IDataObject as Avalonia.Input.DataObject.

public static bool TryClone(this IDataObject data, out DataObject? clone)

Parameters

data IDataObject

Avalonia.Input.IDataObject to clone.

clone DataObject

Cloned Avalonia.Input.IDataObject as Avalonia.Input.DataObject.

Returns

bool

True if cloning successfully.

TryClone(IDataObject, out DataObject?, out Exception?)

Try cloning Avalonia.Input.IDataObject as Avalonia.Input.DataObject.

public static bool TryClone(this IDataObject data, out DataObject? clone, out Exception? exception)

Parameters

data IDataObject

Avalonia.Input.IDataObject to clone.

clone DataObject

Cloned Avalonia.Input.IDataObject as Avalonia.Input.DataObject.

exception Exception

Exception occurred while cloning.

Returns

bool

True if cloning successfully.

TryGetData<T>(IDataObject, string, out T?)

Try getting the data with given format and type.

public static bool TryGetData<T>(this IDataObject dataObject, string format, out T? data) where T : class

Parameters

dataObject IDataObject

Avalonia.Input.IDataObject.

format string

Format.

data T

Data.

Returns

bool

True if data got successfully.

Type Parameters

T

Type of data.

TryGetData<T>(IDataObject, string, out T?, out Exception?)

Try getting the data with given format and type.

public static bool TryGetData<T>(this IDataObject dataObject, string format, out T? data, out Exception? exception) where T : class

Parameters

dataObject IDataObject

Avalonia.Input.IDataObject.

format string

Format.

data T

Data.

exception Exception

Exception occurred while getting data.

Returns

bool

True if data got successfully.

Type Parameters

T

Type of data.

TryGetSingleFileName(IDataObject, out string?)

Get the only file name contained in Avalonia.Input.IDataObject.

public static bool TryGetSingleFileName(this IDataObject data, out string? fileName)

Parameters

data IDataObject

Avalonia.Input.IDataObject.

fileName string

File name contained in Avalonia.Input.IDataObject.

Returns

bool

True if only one file name contained in Avalonia.Input.IDataObject, or false if no file name or more than one file names are contained.

TryGetSingleFileName(IDataObject, out string?, out Exception?)

Get the only file name contained in Avalonia.Input.IDataObject.

public static bool TryGetSingleFileName(this IDataObject data, out string? fileName, out Exception? exception)

Parameters

data IDataObject

Avalonia.Input.IDataObject.

fileName string

File name contained in Avalonia.Input.IDataObject.

exception Exception

Exception occurred while getting data.

Returns

bool

True if only one file name contained in Avalonia.Input.IDataObject, or false if no file name or more than one file names are contained.

TryGetValue<T>(IDataObject, string, out T)

Try getting the value type data with given format and type.

public static bool TryGetValue<T>(this IDataObject dataObject, string format, out T value) where T : struct

Parameters

dataObject IDataObject

Avalonia.Input.IDataObject.

format string

Format.

value T

Value.

Returns

bool

True if value got successfully.

Type Parameters

T

Type of data.

TryGetValue<T>(IDataObject, string, out T, out Exception?)

Try getting the value type data with given format and type.

public static bool TryGetValue<T>(this IDataObject dataObject, string format, out T value, out Exception? exception) where T : struct

Parameters

dataObject IDataObject

Avalonia.Input.IDataObject.

format string

Format.

value T

Value.

exception Exception

Exception occurred while getting data.

Returns

bool

True if value got successfully.

Type Parameters

T

Type of data.