ToastNotificationManager.GetTemplateContent(ToastTemplateType) Method

Reference

Definition

Namespace:: Windows.UI.Notifications

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Gets the XML content of one of the predefined toast templates so that you can customize it for use in your notification.

public:
 static XmlDocument ^ GetTemplateContent(ToastTemplateType type);

 static XmlDocument GetTemplateContent(ToastTemplateType const& type);

public static XmlDocument GetTemplateContent(ToastTemplateType type);

function getTemplateContent(type)

Public Shared Function GetTemplateContent (type As ToastTemplateType) As XmlDocument

Parameters

type: ToastTemplateType

One of the system-provided toast templates.

Returns

XmlDocument

The object that contains the template XML.

Examples

The following example shows how to create and send a toast notification that includes text and images, including the use of the GetTemplateContent method.

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

Remarks

Instead of creating the full XML payload yourself, you can get a template and then use Document Object Model (DOM) manipulation functions to customize the part of the content that you want to change. You package this XML in a ToastNotification and send it to the tile through the ToastNotifier that you create through the other methods of this class.

See tile schema for an explanation of tile elements and attributes.

Applies to

Dela via