WebView.DataTransferPackage Property

Definition

Note

DataTransferPackage may be altered or unavailable for releases after Windows 8.1. Instead, use CaptureSelectedContentToDataPackageAsync.

Gets a clipboard DataPackage as passed to the WebView.

C#
public DataPackage DataTransferPackage { [Windows.Foundation.Metadata.Deprecated("Use CaptureSelectedContentToDataPackageAsync instead of DataTransferPackage. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.Foundation.UniversalApiContract))] get; }
C#
public DataPackage DataTransferPackage { [Windows.Foundation.Metadata.Deprecated("Use CaptureSelectedContentToDataPackageAsync instead of DataTransferPackage. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Foundation.UniversalApiContract")] get; }

Property Value

A clipboard data package.

Attributes

Examples

The following code example demonstrates how to use this property to implement sharing support.

C++
void SDKSample::WebViewControl::Scenario7::Share_Click(Platform::Object^ sender, Windows::UI::Xaml::RoutedEventArgs^ e)
{
    dataTransferManager = DataTransferManager::GetForCurrentView();
    dataRequestedToken = dataTransferManager->DataRequested += ref new TypedEventHandler<DataTransferManager^, DataRequestedEventArgs^>(this, &Scenario7::dataTransferManager_DataRequested);
    DataTransferManager::ShowShareUI();
}

// Data requested handler
void SDKSample::WebViewControl::Scenario7::dataTransferManager_DataRequested(DataTransferManager^ sender, DataRequestedEventArgs^ args)
{
    DataRequest^ request = args->Request;
    DataPackage^ p = WebView7->DataTransferPackage;
    
    if (p->GetView()->Contains(StandardDataFormats::Text))
    {
        p->Properties->Title = "WebView Sharing Excerpt";
        p->Properties->Description = "This is a snippet from the content hosted in the WebView control";
        request->Data = p;
    }
    else
    {
        request->FailWithDisplayText("Nothing to share");
    }
    dataTransferManager->DataRequested -= dataRequestedToken;
}
C#
private void Share_Click(object sender, RoutedEventArgs e)
{
    dataTransferManager = DataTransferManager.GetForCurrentView();
    dataTransferManager.DataRequested += dataTransferManager_DataRequested;
    DataTransferManager.ShowShareUI();
}

void dataTransferManager_DataRequested(DataTransferManager sender, DataRequestedEventArgs args)
{
    DataRequest request = args.Request;
    DataPackage p = WebView7.DataTransferPackage;

    if (p.GetView().Contains(StandardDataFormats.Text))
    {
        p.Properties.Title = "WebView Sharing Excerpt";
        p.Properties.Description = "This is a snippet from the content hosted in the WebView control";
        request.Data = p;
    }
    else
    {
        request.FailWithDisplayText("Nothing to share");
    }
    dataTransferManager.DataRequested -= dataTransferManager_DataRequested;
}

Remarks

This property is typically used to support sharing. During a share operation, the source app puts the data being shared in a DataPackage object and sends that object to the target app for processing.

Applies to

Product Versions
WinRT Build 10240, Build 10586, Build 14383, Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100

See also