binding (Tile schema)

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

Element hierarchy

<tile>
<visual>
<binding>

Syntax

<binding template       = tileTemplateNameV2
         fallback?      = tileTemplateNameV1
         lang?          = string
         baseUri?       = anyURI
         branding?      = "none" | "logo" | "name"
         addImageQuery? = boolean
         contentId?     = string >

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

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 logo
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
fallback

A template to use if the primary template name is not recognized by the recipient, for use with Windows 8 compatibility. This value is the Windows 8 name of the value in the template attribute. New templates introduced after Windows 8 do not have a fallback.

tileTemplateNameV1 (see Remarks) 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. See Remarks for when this value isn't specified.

string No None
template

One of the provided templates on which to base the tile. Typically, a developer should supply both a square and a wide format, each as a separate binding element. Valid entries are members of the tileTemplateType enumeration.

tileTemplateNameV2 (see Remarks) Yes None

 

Child Elements

Child Element Description
image

Specifies an image used in the tile template. The supplied image should match the size and shape requirements for the specific template or image within that template.

text

Specifies text used in the tile template.

 

Parent Elements

Parent Element Description
visual

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

 

Remarks

The tileTemplateNameV2 value used in the template attribute can be one of the following string values. For details on each template, see The tile template catalog.

  • TileSquare150x150Block
  • TileSquare150x150Image
  • TileSquare150x150PeekImageAndText01
  • TileSquare150x150PeekImageAndText02
  • TileSquare150x150PeekImageAndText03
  • TileSquare150x150PeekImageAndText04
  • TileSquare150x150Text01
  • TileSquare150x150Text02
  • TileSquare150x150Text03
  • TileSquare150x150Text04
  • TileSquare310x310BlockAndText01
  • TileSquare310x310BlockAndText02
  • TileSquare310x310Image
  • TileSquare310x310ImageAndText01
  • TileSquare310x310ImageAndText02
  • TileSquare310x310ImageAndTextOverlay01
  • TileSquare310x310ImageAndTextOverlay02
  • TileSquare310x310ImageAndTextOverlay03
  • TileSquare310x310ImageCollection
  • TileSquare310x310ImageCollectionAndText01
  • TileSquare310x310ImageCollectionAndText02
  • TileSquare310x310SmallImagesAndTextList01
  • TileSquare310x310SmallImagesAndTextList02
  • TileSquare310x310SmallImagesAndTextList03
  • TileSquare310x310SmallImagesAndTextList04
  • TileSquare310x310Text01
  • TileSquare310x310Text02
  • TileSquare310x310Text03
  • TileSquare310x310Text04
  • TileSquare310x310Text05
  • TileSquare310x310Text06
  • TileSquare310x310Text07
  • TileSquare310x310Text08
  • TileSquare310x310TextList01
  • TileSquare310x310TextList02
  • TileSquare310x310TextList03
  • TileWide310x150BlockAndText01
  • TileWide310x150BlockAndText02
  • TileWide310x150Image
  • TileWide310x150ImageAndText01
  • TileWide310x150ImageAndText02
  • TileWide310x150ImageCollection
  • TileWide310x150PeekImage01
  • TileWide310x150PeekImage02
  • TileWide310x150PeekImage03
  • TileWide310x150PeekImage04
  • TileWide310x150PeekImage05
  • TileWide310x150PeekImage06
  • TileWide310x150PeekImageAndText01
  • TileWide310x150PeekImageAndText02
  • TileWide310x150PeekImageCollection01
  • TileWide310x150PeekImageCollection02
  • TileWide310x150PeekImageCollection03
  • TileWide310x150PeekImageCollection04
  • TileWide310x150PeekImageCollection05
  • TileWide310x150PeekImageCollection06
  • TileWide310x150SmallImageAndText01
  • TileWide310x150SmallImageAndText02
  • TileWide310x150SmallImageAndText03
  • TileWide310x150SmallImageAndText04
  • TileWide310x150SmallImageAndText05
  • TileWide310x150Text01
  • TileWide310x150Text02
  • TileWide310x150Text03
  • TileWide310x150Text04
  • TileWide310x150Text05
  • TileWide310x150Text06
  • TileWide310x150Text07
  • TileWide310x150Text08
  • TileWide310x150Text09
  • TileWide310x150Text10
  • TileWide310x150Text11

The tileTemplateNameV1 value used in the fallback attribute can be one of the following string values. These are the Windows 8 template names. For details on each template, see The tile template catalog.

  • TileSquareBlock
  • TileSquareImage
  • TileSquarePeekImageAndText01
  • TileSquarePeekImageAndText02
  • TileSquarePeekImageAndText03
  • TileSquarePeekImageAndText04
  • TileSquareText01
  • TileSquareText02
  • TileSquareText03
  • TileSquareText04
  • TileWideBlockAndText01
  • TileWideBlockAndText02
  • TileWideImage
  • TileWideImageAndText01
  • TileWideImageAndText02
  • TileWideImageCollection
  • TileWidePeekImage01
  • TileWidePeekImage02
  • TileWidePeekImage03
  • TileWidePeekImage04
  • TileWidePeekImage05
  • TileWidePeekImage06
  • TileWidePeekImageAndText01
  • TileWidePeekImageAndText02
  • TileWidePeekImageCollection01
  • TileWidePeekImageCollection02
  • TileWidePeekImageCollection03
  • TileWidePeekImageCollection04
  • TileWidePeekImageCollection05
  • TileWidePeekImageCollection06
  • TileWideSmallImageAndText01
  • TileWideSmallImageAndText02
  • TileWideSmallImageAndText03
  • TileWideSmallImageAndText04
  • TileWideSmallImageAndText05
  • TileWideText01
  • TileWideText02
  • TileWideText03
  • TileWideText04
  • TileWideText05
  • TileWideText06
  • TileWideText07
  • TileWideText08
  • TileWideText09
  • TileWideText10
  • TileWideText11

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](/previous-versions/windows/apps/jj552947(v=win.10)) 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](/previous-versions/windows/apps/jj552947(v=win.10)) 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](/previous-versions/windows/apps/jj552947(v=win.10)#resourcecontext) used to resolve the string
  • Else the [ResourceContext](/previous-versions/windows/apps/jj552947(v=win.10)#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](/previous-versions/windows/apps/jj552947(v=win.10)#resourcecontext) used to resolve the string
  • Else the [ResourceContext](/previous-versions/windows/apps/jj552947(v=win.10)#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](/previous-versions/windows/apps/jj552947(v=win.10)) 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

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