BackgroundTaskProgressEventArgs クラス

  • リファレンス

定義

名前空間:
Windows.ApplicationModel.Background
編集

進行状況更新通知が送信された時点のタスクの進行状況情報を表します。

public ref class BackgroundTaskProgressEventArgs sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BackgroundTaskProgressEventArgs final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BackgroundTaskProgressEventArgs
Public NotInheritable Class BackgroundTaskProgressEventArgs
継承
Object Platform::Object IInspectable BackgroundTaskProgressEventArgs
属性
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

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

例

次の例では、BackgroundTaskProgressEventArgs クラスと BackgroundTaskProgressEventHandler デリゲートを使用して、アプリがフォアグラウンドにある間のバックグラウンド タスクの進行状況を表示する方法を示します。

private async void OnProgress(IBackgroundTaskRegistration task, BackgroundTaskProgressEventArgs args)
{
    //
    // UI element updates should be done asynchronously.
    //
    await Dispatcher.RunAsync(CoreDispatcherPriority.Normal,
    () =>
    {
        ExampleProgressElement.Text = "Progress is at " args.Progress + "%.";
    });
}

注釈

システムはこのクラスを生成し、アプリケーションの BackgroundTaskProgressEventHandler ハンドラーに引数として渡します。

プロパティ

InstanceId

この進行状況の状態通知のバックグラウンド タスク インスタンスの識別子を取得します。
Progress

バックグラウンド タスク インスタンスの進行状況を取得します。

適用対象