DataPackageView クラス

リファレンス

定義

名前空間:: Windows.ApplicationModel.DataTransfer

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

DataPackage の読み取り専用バージョン。共有コンテンツを受け取るアプリは、コンテンツを取得するときにこのオブジェクトを取得します。

public ref class DataPackageView sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class DataPackageView final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class DataPackageView

Public NotInheritable Class DataPackageView

継承: Object Platform::Object IInspectable DataPackageView

属性: ContractVersionAttribute MarshalingBehaviorAttribute

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

次のコードは、DataPackageView を使用して共有されているテキストを取得する方法を示しています。この例を正しく機能させるには、共有操作に応答してアプリが起動されたかどうかを検出するコードを追加する必要があります。詳細については、「テキストを受け取る方法」のトピックを参照してください。

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);
        }
    });
}

注釈

共有操作中に、ソースアプリは、共有されているデータを DataPackage オブジェクトに格納し、そのオブジェクトをターゲットアプリに送信して処理します。 DataPackage クラスには、text、Rtf、Html、Bitmap、および StorageItems という既定の形式をサポートする多数のメソッドが含まれています。また、カスタムデータ形式をサポートするメソッドもあります。これらの形式を使用するには、ソースアプリとターゲットアプリの両方で、カスタム形式が存在することを既に認識している必要があります。

ターゲットアプリでは、DataPackageView オブジェクトを使用して、共有されているデータを取得できます。さらに、これらのアプリでは AvailableFormats プロパティを使用して、DataPackageView でサポートされている形式を識別したり、 Contains メソッドを使用して特定の形式を照会したりできます。

ソースアプリには、 SetDataProvider を使用して、データをすぐに提供するのではなく、 DataPackage にデリゲートを割り当てるオプションがあります。このプロセスは、ソースアプリが特定の形式をサポートしているが、ターゲットアプリがデータを要求しない限りデータを生成しない場合に便利です。たとえば、ソースアプリでは、写真を共有するためのさまざまな画像形式がサポートされている場合があります。ソースアプリでは、これらの形式を使用して各イメージの複数のコピーを作成する代わりに、ターゲットアプリが特定の形式の種類を要求したときに呼び出されるデリゲートを使用できます。

バージョン履歴

Windows のバージョン	SDK バージョン	追加された値
1511	10586	SetAcceptedFormatId

プロパティ

AvailableFormats	DataPackageView に含まれる形式を返します。
Properties	DataPackageView オブジェクト内のデータのプロパティの読み取り専用セットを含む DataPackagePropertySetView オブジェクトを取得します。
RequestedOperation	要求された操作 (コピーや移動など) を取得します。主にクリップボードアクションに使用されます。

メソッド

Contains(String)	DataPackageView に特定のデータ形式が含まれているかどうかを確認します。
GetApplicationLinkAsync()	DataPackageView オブジェクト内のアプリケーションリンクを取得します。
GetBitmapAsync()	DataPackageView に含まれるビットマップイメージを取得します
GetDataAsync(String)	DataPackageView に含まれるデータを取得します。
GetHtmlFormatAsync()	DataPackageView オブジェクトに格納されている HTML を取得します。
GetResourceMapAsync()	HTML コンテンツで参照されるデータ (画像など) を取得します。
GetRtfAsync()	DataPackageView に含まれるリッチテキスト形式 (RTF) コンテンツを取得します。
GetStorageItemsAsync()	DataPackageView オブジェクトに格納されているファイルとフォルダーを取得します。
GetTextAsync()	DataPackageView オブジェクトのテキストを取得します。
GetTextAsync(String)	DataPackageView オブジェクトのテキストを取得します。
GetUriAsync()	注意 getUriAsync は、Windows 8.1後にリリースで変更または使用できない場合があります。代わりに、 GetApplicationLink または GetWebLink を使用します。 DataPackageView に含まれる URI を取得します。
GetWebLinkAsync()	DataPackageView オブジェクト内の Web リンクを取得します。
ReportOperationCompleted(DataPackageOperation)	DataPackageView オブジェクトを使用してアプリが終了したことをシステムに通知します。主にクリップボード操作に使用されます。
RequestAccessAsync()	保護ポリシーで保護されているデータパッケージのロックを解除してアクセスするためのアクセス許可を要求します。
RequestAccessAsync(String)	保護ポリシーで保護されているデータパッケージのロックを解除してアクセスするためのアクセス許可を要求します。
SetAcceptedFormatId(String)	受け入れられる形式 ID を設定します。
UnlockAndAssumeEnterpriseIdentity()	データパッケージのロックを解除し、そのエンタープライズ ID を想定します。

適用対象