ToastContentBuilder.AddProgressBar Method

Reference

Definition

Namespace:: Microsoft.Toolkit.Uwp.Notifications

Assembly:: Microsoft.Toolkit.Uwp.Notifications.dll

Package:: Microsoft.Toolkit.Uwp.Notifications v6.1.1

Package:: Microsoft.Toolkit.Uwp.Notifications v7.0.2

Package:: Microsoft.Toolkit.Uwp.Notifications v7.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Add a progress bar to the toast.

public Microsoft.Toolkit.Uwp.Notifications.ToastContentBuilder AddProgressBar (string title = default, double? value = default, bool isIndeterminate = false, string valueStringOverride = default, string status = default);

member this.AddProgressBar : string * Nullable<double> * bool * string * string -> Microsoft.Toolkit.Uwp.Notifications.ToastContentBuilder

Public Function AddProgressBar (Optional title As String = Nothing, Optional value As Nullable(Of Double) = Nothing, Optional isIndeterminate As Boolean = false, Optional valueStringOverride As String = Nothing, Optional status As String = Nothing) As ToastContentBuilder

Parameters

title: String

Title of the progress bar.

value: Nullable<Double>

Value of the progress bar. Default is 0

isIndeterminate: Boolean

Determine if the progress bar value should be indeterminate. Default to false.

valueStringOverride: String

An optional string to be displayed instead of the default percentage string. If this isn't provided, something like "70%" will be displayed.

status: String

A status string which is displayed underneath the progress bar. This string should reflect the status of the operation, like "Downloading..." or "Installing...". Default to empty.

Returns

ToastContentBuilder

The current instance of ToastContentBuilder

Remarks

More info at: https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/toast-progress-bar

Applies to