Share via

Facebook x.com LinkedIn Email

Pinned site metadata reference

  • 2015年10月26日

You can customize pinned sites using the meta element, including the name of your pinned site, the background for various tile sizes, notification updates,badges, and more. Here's a list of the supported metadata values and what they do.

In this topic:

  • application-name
  • msapplication-allowDomainApiCalls
  • msapplication-allowDomainMetaTags
  • msapplication-badge
  • msapplication-config
  • msapplication-navbutton-color
  • msapplication-notification
  • msapplication-square150x150logo
  • msapplication-square310x310logo
  • msapplication-square70x70logo
  • msapplication-wide310x150logo
  • msapplication-starturl
  • msapplication-task
  • msapplication-task-separator
  • msapplication-TileColor
  • msapplication-TileImage
  • msapplication-tooltip
  • msapplication-window

Be aware that preset values are case-sensitive and must be specified using the case shown. Invalid values are ignored.

For more information, including a task-based walkthrough, see IE11 pinned site enhancements.

application-name

The default name displayed with the pinned sites tile (or icon). Set the content attribute to the desired name.

<meta name="application-name" content="Contoso Pinned Site Caption">

msapplication-allowDomainApiCalls

Allows tasks to be defined on child domains of the fully qualified domain name associated with the pinned site.

The content attribute should be set to a value indicating whether this is allowed (true) or not (false).

<meta name="msapplication-allowDomainApiCalls" content="true">

This is supported only on the webpage used to install the pinned site. It cannot be changed afterward.

Note The msapplication-allowDomainApiCalls value is only supported in Internet Explorer 11 on Windows 10.

msapplication-allowDomainMetaTags

Allows tasks to be defined on child domains of the fully qualified domain name associated with the pinned site.

The content attribute should be set to a value indicating whether this is allowed (true) or not (false).

<meta name="msapplication-allowDomainMetaTags" content="true">

This is supported only on the webpage used to install the pinned site. It cannot be changed afterward.

Note The msapplication-allowDomainMetaTags value is only supported in IE11 on Windows 10.

msapplication-badge

Defines a badge for a live tile.

The value of the content attribute is a semi-colon separated string containing the following component values:

Component Description
frequency (Optional) Indicates the frequency, in minutes, that a client should check for updates to the polling URL. The supported values are 30, 60, 360 (6 hours), 720 (12 hours), and 1440 (1 day). If no value is specified, the default value of 1440 minutes is used.
polling-uri The content value "polling-uri" is required and specifies the URI for an XML file containing badge schema. Only "http" and "https" URI schemes are supported.

The following example combine several components:

<meta name="msapplication-badge" content="frequency=30; polling-uri=http://example.com/id45453245/polling.xml">

Note The msapplication-badge value is supported as of Windows 8.

msapplication-config

Identifies an XMLfile that contains browser configuration schema that defines live tile customizations.

The value of the content attribute refers to a fully-qualified or relative Uniform Resource Identifier (URI) containing the address of the XML file. The default value is "browerconfig.xml".

<meta name="msapplication-config" content=" https://contoso.com/browserconfig.xml"/>

Note The msapplication-config value is supported as of IE11.

msapplication-navbutton-color

Defines the custom color of the Back and Forward buttons in the Pinned site browser window.

The content attribute can be any named color or supported hex color value. For a complete list of color names, see Color Table.

<meta name="msapplication-navbutton-color" content="#FF3300">

If msapplication-navbutton-color is not specified, the default color is based on the color palette of the site icon (or, favicon). To learn how to select a custom icon for your site, see Customizing the Site Icon.

Note The msapplication-navbutton-color value is only supported in IE11 on Windows 10.

Note As of Internet Explorer 10, msapplication-navbutton-color is supported only for Internet Explorer for the desktop.

msapplication-notification

Identifies up to five URLs to periodically poll for notifications.

The content attribute is a semi-colon (";") separated string containing the following component values:

Component Description
frequency (Optional) Indicates the frequency, in minutes, that the target URLs should be polledThe supported values are 30, 60, 360 (6 hours), 720 (12 hours), and 1440 (1 day). If no value is specified, the default value of 1440 minutes is used.
cycle (Optional) Indicates whether notifications cycle and, if so, for which tiles. Must be one of the following values:
  • "0": None (default if only a single URL)
  • "1": None (default for multiple URLs)
  • "2": Medium tile only.
  • "3": Wide only.
  • "4": Large only.
  • "5": Update wide and medium tiles
  • "6": Update large and medium tiles
  • "7": Update large and wide tiles
polling-uri The content value "polling-uri" is required and indicates the URL to poll for notification binding. Only "http" and "https" URI schemes are supported.
polling-uri2 (Optional) A second notification binding XML file.
polling-uri3 (Optional) A third notification binding XML file.
polling-uri4 (Optional) A fourth notification binding XML file.
polling-uri5 (Optional) A fifth notification binding XML file.

Examples:

<meta name="msapplication-notification" 
 content="frequency=60;polling-uri=https://contoso.com/livetile">
 
<meta name="msapplication-notification" 
 content="frequency=30;polling-uri=https://contoso.com/livetile; 
 polling-uri2=https://contoso.com/livetile2;polling-uri3=https://contoso.com/livetile3; 
 polling-uri4=https://contoso.com/livetile4;polling-uri5=https://contoso.com/livetile5">

Note The msapplication-notification value is only supported in Microsoft Edge on Windows 10 and applies to tiles pinned to the Windows Start screen.

Specifies the image to use as the medium tile, which is 150x150 pixels at 100% scaling.

<meta name="msapplication-square150x150logo" content="images/logo.png">

Note The msapplication-square150x150logo value is only supported in Microsoft Edge on Windows 10 and applies to tiles pinned to the Windows Start screen.

Specifies the image to use as the large tile, which is 310x310 pixels at 100% scaling.

<meta name="msapplication-square310x310logo" content="images/largelogo.png">

Note The msapplication-square310x310logo value is only supported in Microsoft Edge on Windows 10 and applies to tiles pinned to the Windows Start screen.

Specifies the image to use as the small tile, which is 70x70 pixels at 100% scaling.

<meta name="msapplication-square70x70logo" content="images/tinylogo.png">

Note The msapplication-square70x70logo value is only supported in Microsoft Edge on Windows 10 and applies to tiles pinned to the Windows Start screen.

Specifies the image to use as the wide tile, which is 310x150 pixels at 100% scaling.

<meta name="msapplication-wide310x150logo" content="images/widelogo.png">

Note The msapplication-square310x150logo value is only supported in Microsoft Edge on Windows 10 and applies to tiles pinned to the Windows Start screen.

msapplication-starturl

The root URL of the pinned site. The content attribute specifies the URL, which can fully qualified or relative to the current document. Only HTTP and HTTPS protocols are allowed. If this element is missing, the address of the current page is used instead.

msapplication-task

Defines a Jump list task. The value of the content attribute is a semi-colon separated value containing the following component values:

Component Description
name A string that contains the name of the task displayed in the Jump list..
action-uri A fully qualified or relative URI containing the address of the document to be launched when the Jump list task is clicked.
icon-uri A fully qualified or relative URI containing the address of the icon to be displayed for the Jump list task.
window-type One of the following values:
  • "tab": (default): Task opens as a new tab in the current window.
  • "self": task opens in the curent window.
  • "window": task opens as a new Pinned site window.

This example shows how to specify a jumplist task:

<meta content="name=Check Order Status;
 action-uri=./orderStatus.aspx?src=IE9;
 icon-uri=./favicon.ico" name="msapplication-task">

Note The msapplication-task value is only supported in IE11 on Windows 10.

msapplication-task-separator

Places a visible line between tasks in the Jump List menu. The separators must be made unique by setting each content attribute to a unique value if you have more than one separator.

Note The msapplication-task-seperator value is only supported in IE11 on Windows 10.

msapplication-TileColor

Sets the background color for a live tile.

The content value specifies supported named color or hex color value. For a complete list of color names, see Color Table.

<meta name="msapplication-TileColor" content="#FF3300">

Note The msapplication-TileColor value is only supported in Microsoft Edge on Windows 10.

Note Only named values and hex values will be supported as of Windows 10.

msapplication-TileImage

Specifies the background image for live tile.

The content value specifies a URI for the desired image.

<meta name="msapplication-TileImage" content="images\tileimage.jpg">

Note The msapplication-TileImage value is only supported in Microsoft Edge on Windows 10.

Note The msapplication-TileImage metadata is supported as of Windows 8.

msapplication-tooltip

Provides additional tooltip text that appears when you hover over the Pinned site shortcut.

The content attribute should be set to the desired tooltip text.

<meta name="msapplication-tooltip" content="Example Tooltip Text">

Note The msapplication-tooltip value is only supported in IE11 on Windows 10.

Note As of Internet Explorer 10, msapplication-tooltip is supported only for Internet Explorer for the desktop.

msapplication-window

Sets the initial size of the Pinned site window when it is launched for the first time. However, if the user adjusts the size of the window, the Pinned site retains the new dimensions when it is launched again.

The content attribute is a string that specifies the initial size of the Pinned site window when it is launched for the first time, as shown in the following example:

<meta name="msapplication-window" content="width=1024;height=768">

The content value must contain values for both the width and height. Each value specifies, in pixels, the desired size.

If the user adjusts the size of the window, the Pinned site retains the new dimensions when it is launched again.

Note The msapplication-window value is only supported in IE11 on Windows 10.

Note As of Internet Explorer 10, msapplication-window is supported only for Internet Explorer for the desktop.