Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 3.56 KB

windows-applicationmodel-datatransfer.md

File metadata and controls

84 lines (59 loc) · 3.56 KB

Uno Support for Windows.ApplicationModel.DataTransfer

Clipboard

Feature Android iOS macOS WASM
SetContent
GetContent
Flush
Clear
ContentChanged

Limitations

SetContent and GetContent APIs currently support textual data on all platforms. On Android, they also support URI and HTML formats, but clipboard can hold only one item. Setting multiple items at once does not work reliably.

Flush operation has an empty implementation. In contrast to UWP, on other platforms data automatically remain in the clipboard even after application is closed.

ContentChanged event can observe clipboard changes only when the application is in the foreground.

On macOS, the ContentChanged event checks for clipboard changes by polling the current NSPasteboard change count in 1 second intervals. The polling starts only after first subscriber attaches to ContentChanged event and stops after the last subscriber unsubscribes.

DataTransferManager

Data transfer manager allows sharing content from your application using the OS sharing dialog. To check whether sharing is supported at runtime, use IsSupported() method:

if (DataTransferManager.IsSupported())
{
    // Sharing is supported    
}

Currently, the following types of content can be shared:

Type of content Android iOS macOS WASM Tizen
Text
Uri
File

To set up the DataTransferManager use the following snippet:

var dataTransferManager = DataTransferManager.GetForCurrentView();
dataTransferManager.DataRequested += DataRequested;
dataTransferManager.ShowShareUI();

Make sure to unregister the DataRequested event after finished sharing.

In the DataRequested method, you can set the data to be shared in the DataRequestedEventArgs:

private void DataRequested(DataTransferManager sender, DataRequestedEventArgs args)
{        
    args.Request.Data.Properties.Title = "Sharing dialog title";
    args.Request.Data.Properties.Description = "Description";

    args.Request.Data.SetText("Text to share");
    args.Request.Data.SetWebLink(new Uri("https://platform.uno/"));
}

If you need to prepare the data asynchronously, you can use a deferral:

private async void DataRequested(DataTransferManager sender, DataRequestedEventArgs args)
{        
    var deferral = args.Request.GetDeferral();

    args.Request.Data.Properties.Title = "Sharing dialog title";
    args.Request.Data.Properties.Description = "Description";

    var text = await SomeOperationAsync();
    args.Request.Data.SetText(text);
    
    deferral.Complete();
}

To control the location where the sharing dialog shows up on iOS and macOS, use the ShowShareUI(ShareUIOptions) overload. ShareUIOptions.SelectionRect denotes the area the user is interacting with and will be taken into account by the OS. On iOS, you can also specify ShareUIOptions.Theme to make the dialog dark/light based on your app's preference. On other Uno targets, these properties have no effect.

On Tizen, the "http://tizen.org/privilege/appmanager.launch privilege must be declared in the application manifest to allow sharing.