visual (Toast XML Schema)

  • Article

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
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:

  • none
  • logo
  • name
 No None
lang

The target locale of the XML payload, specified as BCP-47 language tags such as "en-US" or "fr-FR". This locale is overridden by any locale specified in binding or 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
version

The version of the toast XML schema this particular payload was developed for.

 integer No 1

 

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 at least a single visual element.

See also