AppNotificationProgressBar Classe

Définition

Espace de noms:

Microsoft.Windows.AppNotifications.Builder

Représente une barre de progression qui s’affiche sur une notification d’application.

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

Héritage

Object Platform::Object IInspectable AppNotificationProgressBar

Attributs

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Exemples

L’exemple suivant illustre l’ajout d’une barre de progression à la charge utile XML pour une notification d’application.

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

Charge utile XML résultante :

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

Mettez à jour les valeurs liées en appelant AppNotificationManager.UpdateAsync et en spécifiant la balise, et éventuellement le groupe, de la balise que vous souhaitez mettre à jour.

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

Remarques

La capture d’écran suivante montre une notification d’application avec une barre de progression.

Ajoutez une barre de progression à la charge utile XML pour une notification d’application en appelant AppNotificationBuilder.AddProgressBar.

Pour obtenir des conseils sur l’utilisation des API AppNotificationBuilder pour créer l’interface utilisateur pour les notifications d’application, consultez Contenu des notifications d’application.

Pour obtenir des informations de référence sur le schéma XML pour les notifications d’application, consultez Schéma de contenu de notification d’application.

Constructeurs

AppNotificationProgressBar()

Initialise une nouvelle instance de la classe AppNotificationProgressBar.

Propriétés

Status	Obtient ou définit le texte status d’une barre de progression de notification d’application.
Title	Obtient ou définit un texte de titre d’une barre de progression de notification d’application.
Value	Obtient ou définit la valeur de progression d’une barre de progression de notification d’application.
ValueStringOverride	Obtient ou définit le remplacement de chaîne de valeur d’une barre de progression de notification d’application.

Méthodes

BindStatus()	Lie la propriété AppNotificationProgressBar.Status .
BindTitle()	Lie la propriété AppNotificationProgressBar.Title .
BindValue()	Lie la propriété AppNotificationProgressBar.Value .
BindValueStringOverride()	Lie la propriété AppNotificationProgressBar.ValueStringOverride .
SetStatus(String)	Définit le texte status d’une barre de progression de notification d’application.
SetTitle(String)	Définit le texte de titre d’une barre de progression de notification d’application.
SetValue(Double)	Définit la valeur de progression d’une barre de progression de notification d’application.
SetValueStringOverride(String)	Définit le remplacement de chaîne de valeur d’une barre de progression de notification d’application.