description | Search.Product | title | ms.assetid | keywords | ms.topic | ms.date |
---|---|---|---|---|---|---|
Specifies the toast template. |
eADQiWindows 10XVcnh |
binding (Toast schema) |
c88c9e7a-d929-4d1b-95e4-65df88cf9844 |
windows 10, uwp, schema, toast notifications |
reference |
04/05/2017 |
Specifies the toast template. Note that only one binding element can be included in a toast notification.
<binding template = "ToastGeneric"
fallback? = string
lang? = string
addImageQuery? = boolean
baseUri? = anyURI
branding? = string >
<!-- Child elements -->
( image
| text
| group
| progress
)*
</binding>
?
optional (zero or one)
*
optional (zero or more)
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 toast 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. |
anyURI | No | ms-appx:/// |
branding | Not used. |
This attribute can have one of the following values:
|
No | None |
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 a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides that in visual, but can be overriden by that in text. 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 | This value must be set to "ToastGeneric" |
string | Yes | None |
Child Element | Description |
---|---|
image | Specifies an image used in the toast template. |
text | Specifies text used in the toast template. |
group | Semantically identifies that the content in the group must either be displayed as a whole, or not displayed if it cannot fit. Groups also allow creating multiple columns. |
progress | Specifies text used in the toast template. |
Parent Element | Description |
---|---|
visual | Contains a single binding element that defines a toast. |