Contains a single binding element that defines a toast.
Element hierarchy
- <toast>
- <visual>
Syntax
<visual version? = integer
lang? = string
baseUri? = anyURI
branding? = "none" | "logo" | "name"
addImageQuery? = boolean >
<!-- Child elements -->
binding+
</visual>
Key
- ? optional (zero or one)
- + required (one or more)
Attributes and Elements
Attributes
| Attribute | Description | Data type | Required | Default value |
|---|---|---|---|---|
| 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 | 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 |
| version |
The version of the toast XML schema this particular payload was developed for. | integer | No | 1 |
| 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 |
Child Elements
| Child Element | Description |
|---|---|
| binding |
Specifies the toast template. Note that only one binding element can be included in a toast notification. |
Parent Elements
| Parent Element | Description |
|---|---|
| toast |
Base toast element, which contains a single visual element. |
Requirements
|
Namespace |
http://schemas.microsoft.com/notifications/2012/toast.xsd |
|---|
Build date: 10/26/2012
