visual

Contains multiple binding child elements, each of which defines a tile.

Element hierarchy

<tile>
<visual>

Syntax

<visual version?       = integer
        lang?          = string
        baseUri?       = anyURI
        branding?      = "none" | "logo" | "name"
        addImageQuery? = boolean
        contentId?     = string >

  <!-- 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 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"

included 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

The form that the tile should use to display the app's brand.

This attribute can have one of the following values:

  • none
  • logo
  • name
No None
contentId

Set to a sender-defined string that uniquely identifies the content of the notification. This prevents duplicates in the situation where a large tile template is displaying the last three wide tile notifications.

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". 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. See Remarks for when this value isn't specified.

string No None
version

The version of the tile XML schema this particular payload was developed for. It can have two values, 1 or 2. Version 1 requires a valid payload under the Windows 8 schema. Version 2 recognizes the new large tile templates, the new Windows 8.1 template names for existing templates, and the fallback attribute of the binding element.

integer No 1

Child Elements

Child Element Description
binding

Specifies the tile template. Every notification should include one binding element for each supported tile size.

Parent Elements

Parent Element Description
tile

Base tile element, which contains a single visual element.

Remarks

The following table explains how the system responds when lang is not specified.

For... The system response
The language for the notification
  • If set explicitly, use visual.lang or binding.lang
  • Else the app specific language setting (the language, if any, that the Resource Management System determines the app will run in given the current language profile)
  • Else the language of the display name on the tile as resolved by Windows Runtime
  • Else the Shell's UI language (MUI language)

This language primarily influences the layout of columns in templates that feature columns.

Text elements with literal text
  • If set explicitly, use visual.lang or binding.lang
  • Else the app specific language setting (the language, if any, that the Resource Management System determines the app will run in given the current language profile)
  • Else the language of the display name on the tile as resolved by Windows Runtime
  • Else the shell's UI language (MUI language)
Text elements with ms-resource content
  • If set explicitly, use visual.lang or binding.lang, and the explicit language is prepended to the language list the Resource Management System's ResourceContext used to resolve the string
  • Else the ResourceContext used as initialized with the user's language profile

After the string is resolved, the language for the resolved string is assigned to the text element. This language shapes the text alignment (LTR vs. RTL) and font selection for UI.

ms-appx:/// image
  • If set explicitly, use visual.lang or binding.lang, the explicit language is prepended to the language list the Resource Management System's ResourceContext used to resolve the string
  • Else the ResourceContext us used as initialized with the user's language profile
Cloud images
  • If set explicitly, use visual.lang or binding.lang
  • Else the app-specific language setting (the language, if any, that the Resource Management System determines the app will run in given the current language profile)
  • Else the language of the display name on the tile as resolved by Windows Runtime (might not be set if the name is language-neutral)
  • Else the Shell's UI language (MUI language)

This language is included in the query string if addImageQuery is true.

Requirements

Namespace

http://schemas.microsoft.com/notifications/2012/tile.xsd