AppNotificationProgressBar クラス

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

アプリ通知に表示される進行状況バーを表します。

public ref class AppNotificationProgressBar sealed

/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Windows.AppNotifications.Builder.AppNotificationBuilderContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Windows.AppNotifications.Builder.AppNotificationBuilderContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppNotificationProgressBar final

[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Windows.AppNotifications.Builder.AppNotificationBuilderContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Windows.AppNotifications.Builder.AppNotificationBuilderContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppNotificationProgressBar

function AppNotificationProgressBar()

Public NotInheritable Class AppNotificationProgressBar

継承

Object Platform::Object IInspectable AppNotificationProgressBar

属性

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

例

次の例では、アプリ通知の XML ペイロードに進行状況バーを追加する方法を示します。

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);
}

注釈

次のスクリーンショットは、進行状況バーを含むアプリ通知を示しています。

AppNotificationBuilder.AddProgressBar呼び出して、アプリ通知の XML ペイロードに進行状況バーを追加します。

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

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

コンストラクター

AppNotificationProgressBar()

AppNotificationProgressBar クラスの新しいインスタンスを初期化します。

プロパティ

Status	アプリ通知の進行状況バーの状態テキストを取得または設定します。
Title	アプリ通知の進行状況バーのタイトル テキストを取得または設定します。
Value	アプリ通知の進行状況バーの進行状況の値を取得または設定します。
ValueStringOverride	アプリ通知の進行状況バーの値文字列のオーバーライドを取得または設定します。

メソッド

BindStatus()	AppNotificationProgressBar.Status プロパティをバインドします。
BindTitle()	AppNotificationProgressBar.Title プロパティをバインドします。
BindValue()	AppNotificationProgressBar.Value プロパティをバインドします。
BindValueStringOverride()	AppNotificationProgressBar.ValueStringOverride プロパティをバインドします。
SetStatus(String)	アプリ通知の進行状況バーの状態テキストを設定します。
SetTitle(String)	アプリ通知の進行状況バーのタイトル テキストを設定します。
SetValue(Double)	アプリ通知の進行状況バーの進行状況の値を設定します。
SetValueStringOverride(String)	アプリ通知の進行状況バーの値文字列のオーバーライドを設定します。