AppNotificationProgressBar.BindValueStringOverride Méthode

Définition

Espace de noms:

Microsoft.Windows.AppNotifications.Builder

Lie la propriété AppNotificationProgressBar.ValueStringOverride.

public:
 virtual AppNotificationProgressBar ^ BindValueStringOverride() = BindValueStringOverride;

AppNotificationProgressBar BindValueStringOverride();

public AppNotificationProgressBar BindValueStringOverride();

function bindValueStringOverride()

Public Function BindValueStringOverride () As AppNotificationProgressBar

Retours

AppNotificationProgressBar

Retourne l’instance AppNotificationProgressBar afin que des appels de méthode supplémentaires puissent être chaînés.

Exemples

L’exemple suivant montre comment définir la propriété ValueStringOverride d’une barre de progression de notification d’application à l’aide de la liaison de données.

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

Mettez à jour la valeur de titre liée en affectant un objet AppNotificationProgressData à la propriété AppNotification.Progress.

Vous pouvez également définir le titre avec la propriété AppNotificationProgressBar.Title ou en appelant AppNotificationProgressBar.SetValueStringOverride.

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

Pour plus d’informations sur le schéma XML pour les notifications d’application, consultez schéma de contenu de notification d’application.