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)	DataPackage に含まれるデータを RandomAccessStream 形式で設定します。
SetDataProvider(String, DataProviderHandler)	ターゲット アプリからの要求を処理するデリゲートを設定します。
SetHtmlFormat(String)	DATAPackage に HTML コンテンツを追加します。
SetRtf(String)	DataPackage に含まれるリッチ テキスト形式 (RTF) コンテンツを設定します。
SetStorageItems(IIterable<IStorageItem>)	DataPackage に含まれるファイルとフォルダーを設定します。
SetStorageItems(IIterable<IStorageItem>, Boolean)	DataPackage にファイルとフォルダーを追加します。
SetText(String)	DataPackage に含まれるテキストを設定します。
SetUri(Uri)	注意 setUri は、Windows 8.1後にリリースで変更または使用できない場合があります。 代わりに、 ApplicationLink または WebLink を 使用 します。 DataPackage に含まれる Uniform Resource Identifier (URI) を設定します。
SetWebLink(Uri)	DataPackage に含まれる Web リンクを設定します。

イベント

Destroyed	DataPackage が破棄されるときに発生します。
OperationCompleted	貼り付け操作が完了したときに発生します。
ShareCanceled	共有が取り消されたときに発生します。
ShareCompleted	共有が完了したときにトリガーされるイベント。 共有は、アプリ、プロバイダー、または連絡先に送信できます。

こちらもご覧ください

• クリップボードのサンプル (Windows 10)
• コンテンツ ソース アプリの共有のサンプル (Windows 10)