AppNotificationProgressBar.BindValueStringOverride メソッド

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

AppNotificationProgressBar.ValueStringOverride プロパティをバインドします。

public:
 virtual AppNotificationProgressBar ^ BindValueStringOverride() = BindValueStringOverride;

AppNotificationProgressBar BindValueStringOverride();

public AppNotificationProgressBar BindValueStringOverride();

function bindValueStringOverride()

Public Function BindValueStringOverride () As AppNotificationProgressBar

戻り値

AppNotificationProgressBar

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

例

次の例は、データ バインディングを使用して、アプリ通知の進行状況バーの ValueStringOverride プロパティを設定する方法を示しています。

var notification = new AppNotificationBuilder()
    .AddText("Downloading your weekly playlist...")
    .AddProgressBar(new AppNotificationProgressBar()
        .BindTitle()
        .BindStatus()
        .BindValue()
        .BindValueStringOverride())
        .SetTag(tagName)
        .SetGroup(groupName))
    .BuildNotification();

var data = new AppNotificationProgressData (sequenceNumber /* Sequence number */);
data.Title = "Retreiving files"; // Binds to {progressTitle} in xml payload
data.Value = (double) currentFile / totalFiles; // Binds to {progressValue} in xml payload
data.ValueStringOverride = String.Format("{0}/{1} files", currentFile, totalFiles); // Binds to {progressValueString} in xml payload
data.Status = "Downloading..."; // Binds to {progressStatus} in xml payload

notification.Progress = data;

AppNotificationManager.Default.Show(notification);

結果の XML ペイロード:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Downloading your weekly playlist...</text>
            <progress title='{progressTitle}' status='{progressStatus}' value='{progressValue}' valueStringOverride='{progressValueString}'/>
        </binding>
    </visual>
</toast>

AppNotificationManager.UpdateAsync 呼び出し、更新するタグのタグ (必要に応じてグループ) を指定して、バインドされた値を更新します。

private async Task UpdateProgressBar()
{
    var data = new AppNotificationProgressData(sequenceNumber /* Sequence number */);
    data.Title = "Retreiving files"; // Binds to {progressTitle} in xml payload
    data.Value = (double)currentFile / totalFiles; // Binds to {progressValue} in xml payload
    data.ValueStringOverride = String.Format("{0}/{1} files", currentFile, totalFiles); // Binds to {progressValueString} in xml payload
    data.Status = (currentFile < totalFiles) ? "Downloading..." : "Complete!"; // Binds to {progressStatus} in xml payload

    await AppNotificationManager.Default.UpdateAsync(data, tagName, groupName);
}

注釈

バインドされたタイトル値を更新するには、AppNotificationProgressData オブジェクトを AppNotification.Progressプロパティに割り当てます。

AppNotificationProgressBar.Title プロパティを使用するか、AppNotificationProgressBar.SetValueStringOverride呼び出してタイトルを設定することもできます。

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

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