DataPackage class

Contains the data that a user wants to exchange with another app.

Syntax

var dataPackage = new Windows.ApplicationModel.DataTransfer.DataPackage();

Attributes

ActivatableAttribute(NTDDI_WIN8)

DualApiPartitionAttribute()

MarshalingBehaviorAttribute(Agile)

VersionAttribute(NTDDI_WIN8)

Members

The DataPackage class has these types of members:

• Constructors
• Events
• Methods
• Properties

Constructors

The DataPackage class has these constructors.

Events

The DataPackage class has these events.

Methods

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

Properties

The DataPackage class has these properties.

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.

Source apps have the option of using SetDataProvider to assign a delegate to a DataPackage, instead of providing the data immediately. This process is useful when the source app supports a given format but does not want to generate the data unless the target app requests the data. 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.

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

Windows Phone 8

This API is supported in native apps only.

Examples

function registerForShare() {
    var dataTransferManager = Windows.ApplicationModel.DataTransfer.DataTransferManager.getForCurrentView();
    dataTransferManager.addEventListener("datarequested", shareTextHandler);
}

function shareTextHandler(e) {
    var request = e.request;
    request.data.properties.title = "Share Text Example";
    request.data.properties.description = "A demonstration that shows how to share.";
    request.data.setText("Hello World!");
}

Requirements

Build date: 2/25/2013