AppNotificationProgressBar Clase

Definición

Espacio de nombres:

Microsoft.Windows.AppNotifications.Builder

Representa una barra de progreso que se muestra en una notificación de aplicación.

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

Herencia

Object Platform::Object IInspectable AppNotificationProgressBar

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Ejemplos

En el ejemplo siguiente se muestra cómo agregar una barra de progreso a la carga XML de una notificación de aplicación.

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

La carga XML resultante:

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

Actualice los valores enlazados llamando a AppNotificationManager.UpdateAsync y especificando la etiqueta y, opcionalmente, el grupo, de la etiqueta que desea actualizar.

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

Comentarios

En la captura de pantalla siguiente se muestra una notificación de aplicación con una barra de progreso.

Agregue una barra de progreso a la carga XML de una notificación de aplicación llamando a AppNotificationBuilder.AddProgressBar.

Para obtener instrucciones sobre cómo usar las API de AppNotificationBuilder para crear la interfaz de usuario para las notificaciones de la aplicación, consulte contenido de notificación de aplicación.

Para obtener información de referencia sobre el esquema XML para las notificaciones de aplicación, consulte esquema de contenido de notificación de aplicación.

Constructores

AppNotificationProgressBar()

Inicializa una nueva instancia de la clase AppNotificationProgressBar.

Propiedades

Status	Obtiene o establece el texto de estado de una barra de progreso de notificación de la aplicación.
Title	Obtiene o establece un texto de título de una barra de progreso de notificación de la aplicación.
Value	Obtiene o establece el valor de progreso de una barra de progreso de notificación de la aplicación.
ValueStringOverride	Obtiene o establece la invalidación de cadena de valor de una barra de progreso de notificación de la aplicación.

Métodos

BindStatus()	Enlaza la propiedad AppNotificationProgressBar.Status.
BindTitle()	Enlaza la propiedad AppNotificationProgressBar.Title.
BindValue()	Enlaza la propiedad AppNotificationProgressBar.Value.
BindValueStringOverride()	Enlaza la propiedad AppNotificationProgressBar.ValueStringOverride.
SetStatus(String)	Establece el texto de estado de una barra de progreso de notificación de la aplicación.
SetTitle(String)	Establece el texto del título de una barra de progreso de notificación de la aplicación.
SetValue(Double)	Establece el valor de progreso de una barra de progreso de notificación de aplicación.
SetValueStringOverride(String)	Establece la invalidación de cadena de valor de una barra de progreso de notificación de aplicación.