ToastNotification Class

Définit le contenu, les métadonnées et les événements associés, et la période d'expiration d'une notification contextuelle.

Syntaxe


var toastNotification = new Windows.UI.Notifications.ToastNotification();

Attributs

[DualApiPartition()]
[Threading(MTA)]
[Version(0x06020000)]

Membres

ToastNotificationClasse possède ces types de membres :

Constructeurs

ToastNotificationClasse possède ces constructeurs.

ConstructeurDescription
ToastNotification Creates and initializes a new instance of the ToastNotification.

 

Événements

ToastNotificationClasse possède ces événements.

ÉvénementDescription
Activated Occurs when user activates a toast notification through a click or touch. Apps that are running subscribe to this event.
Dismissed Occurs when a toast notification leaves the screen, either by expiring or being explicitly dismissed by the user. Apps that are running subscribe to this event.
Failed Occurs when an error is caused when Windows attempts to raise a toast notification. Apps that are running subscribe to this event.

 

Méthodes

The ToastNotification Classe hérite des méthodes de Object Classe (C#/VB/C++).

Propriétés

Le ToastNotificationClasse a les propriétés suivantes.

PropriétéType d'accèsDescription

Content

En lecture seuleGets the XML that defines the current toast notification.

ExpirationTime

Lecture/écritureGets or sets the time after which a toast notification should not be displayed.

 

Remarques

Une application de bureau doit s'abonner à Activated l'événement au moins dès l'activation du handle.

Exemples

L'exemple suivant montre comment créer et envoyer une notification de toast qui comprend du texte et des images, notamment comment utiliser le constructeur ToastNotification.



var notifications = Windows.UI.Notifications;

// Get the toast notification manager for the current app.
var notificationManager = notifications.ToastNotificationManager;

// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object
// that contains the toast notification XML content.
var template = notifications.toastTemplateType.toastImageAndText01;
var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]);

// You can use the methods from the XML document to specify the required elements for the toast.
var images = toastXml.getElementsByTagName("image");
images[0].setAttribute("src", "images/toastImageAndText.png");

var textNodes = toastXml.getElementsByTagName("text");
textNodes.forEach(function (value, index) {
    var textNumber = index + 1;
    var text = "";
    for (var j = 0; j < 10; j++) {
        text += "Text input " + /*@static_cast(String)*/textNumber + " ";
    }
    value.appendChild(toastXml.createTextNode(text));
});

// Create a toast notification from the XML, then create a ToastNotifier object
// to send the toast.
var toast = new notifications.ToastNotification(toastXml);

notificationManager.createToastNotifier().show(toast);

L'exemple suivant montre comment écouter et gérer l'événement Dismissed.



var notifications = Windows.UI.Notifications;

yourToastNotification.addEventListener("dismissed", function (e) {
    switch (e.reason) {
        case notifications.ToastDismissalReason.applicationHidden:
            // The application hid the toast using ToastNotifier.hide.
            break;
        case notifications.ToastDismissalReason.userCanceled:
            // The user dismissed the toast.
            break;
        case notifications.ToastDismissalReason.timedOut:
            // The toast has expired.
            break;
    }
}

Conditions requises

Client minimal pris en charge

Windows 8 [Applications Windows Store, applications de bureau]

Serveur minimal pris en charge

Windows Server 2012 [Applications Windows Store, applications de bureau]

Espace de noms

Windows.UI.Notifications
Windows::UI::Notifications [C++]

Métadonnées

Windows.winmd

Voir aussi

Exemple de notifications de toast
Exemple d'envoi de notifications de toast à partir d'applications de bureau
Schéma XML de toast
Vue d'ensemble de la notification de toast
Démarrage rapide : envoi d'une notification de toast
Démarrage rapide : envoi d'une notification de type push de toast
Démarrage rapide : envoi d'une notification de toast à partir du Bureau
Instructions et liste de contrôle pour les notifications de toast
Comment gérer l'activation à partir d'une notification de toast
Comment opter pour les notifications de toast
Comment planifier une notification de toast
Comment activer les notifications de toast de bureau via un AppUserModelID
Catalogue des modèles de toast
Options audio de toast

 

 

Afficher:
© 2014 Microsoft