BackgroundTaskProgressEventArgs BackgroundTaskProgressEventArgs BackgroundTaskProgressEventArgs BackgroundTaskProgressEventArgs BackgroundTaskProgressEventArgs Class

Definition

Represents progress information for a task at the time a progress update notification is sent.

public : sealed class BackgroundTaskProgressEventArgs
struct winrt::Windows::ApplicationModel::Background::BackgroundTaskProgressEventArgs
public sealed class BackgroundTaskProgressEventArgs
Public NotInheritable Class BackgroundTaskProgressEventArgs
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

The following example shows how to use the BackgroundTaskProgressEventArgs class with a BackgroundTaskProgressEventHandler delegate to show background task progress while the app is in the foreground.


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 + "%.";
    });
}

Remarks

The system generates this class and passes it as an argument to the application's BackgroundTaskProgressEventHandler handler.

Properties

InstanceId InstanceId InstanceId InstanceId InstanceId

Gets the identifier of the background task instance for this progress status notification.

Progress Progress Progress Progress Progress

Gets progress status for a background task instance.