Skip to main content

SetFileAsync Method

Places a file on the clipboard.

Definition

Namespace: Avalonia.Input.Platform
Assembly: Avalonia.Base (in Avalonia.Base.dll)

public static Task SetFileAsync(
this IClipboard clipboard,
IStorageItem? file
)

Parameters

  IClipboard
The clipboard instance.
  IStorageItem
The file to place on the clipboard.

Return Value

Task

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IClipboard. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

By calling this method, the clipboard will get cleared of any possible previous data.

If file is null, nothing will get placed on the clipboard and this method will be equivalent to ClearAsync().

See Also

Reference

ClipboardExtensions Class
Avalonia.Input.Platform Namespace
File