AppNotificationBuilder.AddProgressBar(AppNotificationProgressBar) メソッド

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

アプリ通知の XML ペイロードに進行状況バーを追加します。

public:
 virtual AppNotificationBuilder ^ AddProgressBar(AppNotificationProgressBar ^ value) = AddProgressBar;

AppNotificationBuilder AddProgressBar(AppNotificationProgressBar const& value);

public AppNotificationBuilder AddProgressBar(AppNotificationProgressBar value);

function addProgressBar(value)

Public Function AddProgressBar (value As AppNotificationProgressBar) As AppNotificationBuilder

パラメーター

value

AppNotificationProgressBar

通知に追加する進行状況バーを表す AppNotificationProgressBar 。

戻り値

AppNotificationBuilder

追加のメソッド呼び出しをチェーンできるように、 AppNotificationBuilder インスタンスを返します。

例

次の例では、アプリ通知にコンボ ボックスを追加する方法を示します。

var builder = new AppNotificationBuilder()
        .AddText("Downloading this week's new music...")
        .AddProgressBar(new AppNotificationProgressBar()
            .BindTitle()
            .BindValueStringOverride());

    var data = new AppNotificationProgressData(1 /* Sequence number */);
    data.Title = "Artist Name"; // Binds to {progressTitle} in xml payload
    data.Value = 0.5; // Binds to {progressValue} in xml payload
    data.ValueStringOverride = "1/2 songs"; // Binds to {progressValueString} in xml payload
    data.Status = "Downloading..."; // Binds to {progressStatus} in xml payload

    var notification = builder.BuildNotification();
    notification.Progress = data;

    AppNotificationManager.Default.Show(notification);

結果の XML ペイロード:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Downloading this week&apos;s new music...</text>
            <progress title='{progressTitle}' status='{progressStatus}' value='{progressValue}' valueStringOverride='{progressValueString}'/>
        </binding>
    </visual>
</toast>

注釈

AppNotificationProgressData のフィールドをバインドして、進行状況バーの初期値と更新された状態を設定します。 アプリ通知の進行状況バーへのデータ バインディングの詳細については、「アプリ通知の 進行状況バーとデータ バインディング」を参照してください。

AppNotificationBuilder API を使用してアプリ通知用の UI を作成する方法のガイダンスについては、「アプリ通知コンテンツ」を参照してください。

アプリ通知の XML スキーマのリファレンス情報については、「アプリ通知 コンテンツ スキーマ」を参照してください。