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)	設定 RTF (RTF) 包含在 DataPackage中的內容。
SetStorageItems(IIterable<IStorageItem>)	設定 DataPackage中包含的檔案和資料夾。
SetStorageItems(IIterable<IStorageItem>, Boolean)	將檔案和資料夾新增至 DataPackage。
SetText(String)	設定 DataPackage 包含的文字。
SetUri(Uri)	注意 SetUri 可能會在Windows 8.1之後變更或無法使用版本。 請改用 ApplicationLink 或 WebLink。 設定 DataPackage中包含的統一資源識別項 (URI) 。
SetWebLink(Uri)	設定 DataPackage 包含的 Web 連結。

事件

Destroyed	當 DataPackage 終結時發生。
OperationCompleted	發生于貼上作業完成時。
ShareCanceled	取消共用時引發。
ShareCompleted	共用完成時所觸發的事件。 共用可以傳送至應用程式、提供者或連絡人。

另請參閱

• 剪貼簿範例 (Windows 10)
• 共用內容來源應用程式範例 (Windows 10)