Specifies the toast template. Note that only one binding element can be included in a toast notification.
Element hierarchy
Syntax
<binding template = "ToastImageAndText01" | "ToastImageAndText02" | "ToastImageAndText03" | "ToastImageAndText04" | ...
fallback? = string
lang? = string
baseUri? = anyURI
branding? = "none" | "logo" | "name"
addImageQuery? = boolean >
<!-- Child elements -->
( image
| text
)*
</binding>
Key
- ? optional (zero or one)
- * optional (zero or more)
Attributes and Elements
Attributes
| Attribute | Description | Data type | Required | Default value |
|---|---|---|---|---|
| addImageQuery |
Set to "true" to allow Windows to append a query string to the image URI supplied in the tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of "www.website.com/images/hello.png" given in the notification becomes "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" | boolean | No | false |
| baseUri |
A default base URI that is combined with relative URIs in image source attributes. | URI | No | ms-appx:/// |
| branding |
Not used. |
This attribute can have one of the following values:
| No | logo |
| fallback |
A template to use if the primary template cannot be found, for use with backward compatibility. | string | No | None |
| lang |
The target locale of the XML payload, specified as any defined BCP-47 language code such as "en-US" or "fr-FR". If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string. | string | No | None |
| template |
One of the provided templates on which to base the toast. Values are given in the toastTemplateType enumeration. |
This attribute can have one of the following values:
| Yes | None |
Child Elements
| Child Element | Description |
|---|---|
| image |
Specifies an image used in the toast template. |
| text |
Specifies text used in the toast template. |
Parent Elements
| Parent Element | Description |
|---|---|
| visual |
Contains a single binding element that defines a toast. |
Remarks
To see examples of each of the toast templates, see the toast template catalog.
Requirements
|
Namespace |
http://schemas.microsoft.com/notifications/2012/toast.xsd |
|---|
Build date: 10/26/2012
