AppNotificationProgressBar Classe

Definizione

Spazio dei nomi:

Microsoft.Windows.AppNotifications.Builder

Rappresenta un indicatore di stato visualizzato in una notifica dell'app.

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

Ereditarietà

Object Platform::Object IInspectable AppNotificationProgressBar

Attributi

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Esempio

L'esempio seguente illustra l'aggiunta di un indicatore di stato al payload XML per una notifica dell'app.

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

Payload XML risultante:

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

Aggiornare i valori associati chiamando AppNotificationManager.UpdateAsync e specificando il tag e, facoltativamente, il gruppo del tag da aggiornare.

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

Commenti

Lo screenshot seguente mostra una notifica dell'app con un indicatore di stato.

Aggiungere una barra di stato al payload XML per una notifica dell'app chiamando AppNotificationBuilder.AddProgressBar.

Per indicazioni sull'uso delle API di AppNotificationBuilder per creare l'interfaccia utente per le notifiche dell'app, vedere contenuto di notifica dell'app.

Per informazioni di riferimento su XML Schema per le notifiche delle app, vedere Schema del contenuto di notifica dell'app.

Costruttori

AppNotificationProgressBar()

Inizializza una nuova istanza della classe appNotificationProgressBar .

Proprietà

Status	Ottiene o imposta il testo dello stato di un indicatore di stato di notifica dell'app.
Title	Ottiene o imposta un testo del titolo di un indicatore di stato di notifica dell'app.
Value	Ottiene o imposta il valore dello stato di avanzamento di una notifica dell'app.
ValueStringOverride	Ottiene o imposta l'override della stringa di valore di un indicatore di stato di notifica dell'app.

Metodi

BindStatus()	Associa la proprietà appNotificationProgressBar.Status .
BindTitle()	Associa la proprietà appNotificationProgressBar.Title .
BindValue()	Associa la proprietà AppNotificationProgressBar.Value.
BindValueStringOverride()	Associa la proprietà AppNotificationProgressBar.ValueStringOverride.
SetStatus(String)	Imposta il testo dello stato di un indicatore di stato di notifica dell'app.
SetTitle(String)	Imposta il testo del titolo di un indicatore di stato della notifica dell'app.
SetValue(Double)	Imposta il valore di stato di avanzamento di una notifica dell'app.
SetValueStringOverride(String)	Imposta l'override della stringa di valore di una barra di stato della notifica dell'app.