DataPackageView class

Applies to Windows and Windows Phone

A read-only version of a DataPackage. Apps that receive shared content get this object when acquiring content.

Syntax


public sealed class DataPackageView

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Version(0x06020000)]

Members

The DataPackageView class has these types of members:

Methods

The DataPackageView class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
Contains Checks to see if the DataPackageView contains a specific data format.
GetApplicationLinkAsync Gets the application link in the DataPackageView object.
GetBitmapAsync Gets the bitmap image contained in the DataPackageView
GetDataAsync Gets the data contained in the DataPackageView.
GetHtmlFormatAsync Gets the HTML stored in the DataPackageView object.
GetResourceMapAsync Gets the data (such as an image) referenced in HTML content.
GetRtfAsync Gets the rich text formatted (RTF) content contained in a DataPackageView.
GetStorageItemsAsync Gets the files and folders stored in a DataPackageView object.
GetTextAsync Gets the text in the DataPackageView object.
GetTextAsync(String) Gets the text in the DataPackageView object.
GetUriAsync Gets the URI contained in the DataPackageView.
GetWebLinkAsync Gets the web link in the DataPackageView object.
ReportOperationCompleted Informs the system that your app is finished using the DataPackageView object. Primarily used for Clipboard operations.

 

Properties

The DataPackageView class has these properties.

PropertyAccess typeDescription

AvailableFormats

Read-onlyReturns the formats the DataPackageView contains.

Properties

Read-onlyGets a DataPackagePropertySetView object, which contains a read-only set of properties for the data in the DataPackageView object.

RequestedOperation

Read-onlyGets the requested operation (such as copy or move). Primarily used for Clipboard actions.

 

Remarks

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. The DataPackage class includes a number of methods to support the following default formats: text, Rtf, Html, Bitmap, and StorageItems. It also has methods to support custom data formats. To use these formats, both the source app and target app must already be aware that the custom format exists.

Target apps can use the DataPackageView object to acquire the data being shared. In addition, these apps can use the AvailableFormats property to identify what formats the DataPackageView supports, or the Contains method to query for a specific format.

Source apps have the option of using the SetDataProvider to assign a delegate to a DataPackage, instead of providing the data immediately. This process is useful in situations where the source app supports a given format but does not want to generate the data unless the target app requests it. For example, a source app might support a variety of image formats for sharing photos. Instead of creating multiple copies of each image using these formats, the source app can use a delegate that is called when the target app requests a specific format type.

Examples

The following code shows how you can use the DataPackageView to get the text being shared. For this example to work properly, you need to add code that detects if your app was launched in response to a share operation. See our topic, How to receive text to learn more.


var shareOperation = eventObject.detail.shareOperation;
if (shareOperation.data.contains(Windows.ApplicationModel.DataTransfer.StandardDataFormats.text)) {
    shareOperation.data.getTextAsync().done(function (text) {
            // To output the text using this example, 
            // you need a div tag with an id of "output" in your HTML file.
            document.getElementById("output").innerText = text;
        }, function (e) {
            displayError("Error retrieving Text format: " + e);
        }
    });
}


Requirements

Minimum supported client

Windows 8 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.ApplicationModel.DataTransfer
Windows::ApplicationModel::DataTransfer [C++]

Metadata

Windows.winmd

See also

Sharing content target app sample
Quickstart: Sharing content (Windows Store apps using JavaScript)
Quickstart: Sharing content (Windows Store apps using C#/VB/C++ and XAML)
Quickstart: Receiving shared content (Windows Store apps using JavaScript)
Quickstart: Receiving shared content (Windows Store apps using C#/VB/C++ and XAML)

 

 

Show:
© 2014 Microsoft