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)	設定應用程式通知進度列的值字串覆寫。