DataPackage 类

定义

命名空间:

Windows.ApplicationModel.DataTransfer

包含用户想要与其他应用交换的数据。

public ref class DataPackage sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class DataPackage final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class DataPackage

function DataPackage()

Public NotInheritable Class DataPackage

继承

Object Platform::Object IInspectable DataPackage

属性

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 要求

设备系列	Windows 10 (在 10.0.10240.0 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

示例

//To see this code in action, add a call to ShareSourceLoad to your constructor or other
//initializing function.
private void ShareSourceLoad()
{
    DataTransferManager dataTransferManager = DataTransferManager.GetForCurrentView();
    dataTransferManager.DataRequested += new TypedEventHandler<DataTransferManager, DataRequestedEventArgs>(this.DataRequested);
}

private void DataRequested(DataTransferManager sender, DataRequestedEventArgs e)
{
    DataRequest request = e.Request;
    request.Data.Properties.Title = "Share Text Example";
    request.Data.Properties.Description = "An example of how to share text.";
    request.Data.SetText("Hello World!");
}

注解

在共享操作期间，源应用将共享的数据放在 DataPackage 对象中，并将该对象发送到目标应用进行处理。 DataPackage 类包括许多支持以下默认格式的方法：text、Rtf、Html、Bitmap 和 StorageItems。 它还具有支持自定义数据格式的方法。 若要使用这些格式，源应用和目标应用必须已知道自定义格式存在。

源应用可以选择使用 SetDataProvider 将委托分配给 DataPackage，而不是立即提供数据。 如果源应用支持给定格式，但不希望生成数据，除非目标应用请求数据，则此过程非常有用。 例如，源应用可能支持用于共享照片的各种图像格式。 源应用可以使用在目标应用请求特定格式类型时调用的委托，而不是使用这些格式创建每个图像的多个副本。

目标应用可以使用 DataPackageView 对象来获取要共享的数据。 此外，这些应用可以使用 AvailableFormats 属性来标识 DataPackageView 支持的格式，或使用 Contains 方法查询特定格式。

Windows Phone 8

此 API 仅在本机应用中受支持。

版本历史记录

Windows 版本	SDK 版本	增值
1703	15063	ShareCompleted
2004	19041	ShareCanceled

构造函数

DataPackage()

创建新的 DataPackage 的构造函数。

属性

Properties	允许你获取和设置属性，例如要共享的内容的标题。
RequestedOperation	指定 DataPackageOperation (操作的无、移动、复制或链接) 。
ResourceMap	将 URI 映射到文件。 用于确保引用的内容 (（如 HTML 内容中的图像) ）添加到 DataPackage。

方法

GetView()	返回 DataPackageView 对象。 此对象是 DataPackage 对象的只读副本。
SetApplicationLink(Uri)	设置 DataPackage 包含的应用程序链接。
SetBitmap(RandomAccessStreamReference)	设置 DataPackage 中包含的位图图像。
SetData(String, Object)	以 RandomAccessStream 格式设置 DataPackage 中包含的数据。
SetDataProvider(String, DataProviderHandler)	设置委托以处理来自目标应用的请求。
SetHtmlFormat(String)	将 HTML 内容添加到 DataPackage。
SetRtf(String)	) DataPackage 中包含的内容设置 RTF (RTF 格式。
SetStorageItems(IIterable<IStorageItem>)	设置 DataPackage 中包含的文件和文件夹。
SetStorageItems(IIterable<IStorageItem>, Boolean)	将文件和文件夹添加到 DataPackage。
SetText(String)	设置 DataPackage 包含的文本。
SetUri(Uri)	注意 Windows 8.1后，SetUri 可能会更改或不可用于发布。 请改用 ApplicationLink 或 WebLink。 设置 DataPackage 中包含的统一资源标识符 (URI) 。
SetWebLink(Uri)	设置 DataPackage 包含的 Web 链接。

事件

Destroyed	销毁 DataPackage 时发生。
OperationCompleted	在完成粘贴操作时发生。
ShareCanceled	取消共享时引发。
ShareCompleted	完成共享时触发的事件。 共享可以发送给应用、提供商或联系人。

另请参阅

• 剪贴板示例 (Windows 10)
• 共享内容源应用示例 (Windows 10)