TargetFileRequestDeferral クラス

定義

名前空間:

Windows.Storage.Pickers.Provider

TargetFileRequested イベントへの応答が完了したことを非同期的に示す保存場所を提供するアプリで使用されます。

public ref class TargetFileRequestDeferral sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class TargetFileRequestDeferral final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class TargetFileRequestDeferral

Public NotInheritable Class TargetFileRequestDeferral

継承

Object Platform::Object IInspectable TargetFileRequestDeferral

属性

ContractVersionAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

ファイル ピッカーのサンプルでは、遅延を取得する方法など、TargetFileRequested イベント ハンドラーに応答する方法を示します。

// Event handler
private async void OnTargetFileRequested(FileSavePickerUI sender, TargetFileRequestedEventArgs e)
{
    // Respond to TargetFileRequested event on the background thread on which it was raised

    // Requesting a deferral allows the app to call another asynchronous method and complete the request at a later time
    var deferral = e.Request.GetDeferral();

    // Create file and assign to TargetFile property
    e.Request.TargetFile = await ApplicationData.Current.LocalFolder.CreateFileAsync(sender.FileName, CreationCollisionOption.GenerateUniqueName);

    // Complete the deferral to let the Picker know the request is finished
    deferral.Complete();
}

// Register for the event
fileSavePickerUI.TargetFileRequested += new TypedEventHandler<FileSavePickerUI, TargetFileRequestedEventArgs>(OnTargetFileRequested);

この例では、 eには TargetFileRequestedEventArgs オブジェクトが 含まれています。

注釈

アプリがファイル保存ピッカー コントラクトに参加し、 TargetFileRequested イベントが発生した 場合、アプリは、ユーザーが保存するファイルを表す新しい StorageFile を作成する必要があります。 作成する StorageFile の名前は、 FileName プロパティで指定されたファイルの名前と一致する必要があります。 作成した StorageFile は、呼び出し元アプリがファイルにコンテンツを書き込むことができるように、ファイル ピッカー (呼び出し元アプリ) を呼び出したアプリに返されます。 targetFileRequestedEventArgs でこのイベントに応答する方法の詳細を確認してください。

アプリは、保存場所のプロバイダーとして、targetFileRequestDeferral.complete を呼び出すことによって、TargetFileRequested イベントへの非同期応答が完了したことを通知できます。 TargetFileRequestedEventArgs で TargetFileRequested イベントに非同期的に応答する方法について説明します。

メソッド

Complete()

保存場所を提供するアプリが TargetFileRequested イベントへの応答を完了したことを通知します。