API reference

Pinned sites support a variety of events, methods, and properties.

For a list of supported metadata values, see Metadata reference.

For Pinned site tutorials and walkthroughs, see Pinned site developer documentation

In this section

TopicDescription

msAddSiteMode

Creates a pinned site shortcut to the current webpage on the Windows Start menu.

This method is only supported in Internet Explorer 11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

msClearTile method

Removes notifications from a tile.

msEnableTileNotificationQueue

Controls notification cycling for a tile.

msEnableTileNotificationQueueForSquare150x150

Controls notification cycling for medium (150x150) tiles.

msEnableTileNotificationQueueForSquare310x310

Controls notification cycling for large (310x310) tiles.

msEnableTileNotificationQueueForWide310x150 method

Controls notification cycling for wide (310x150) tiles.

msIsSiteMode

Determines whether the current page was launched as a pinned site.

This method is only supported in IE11 on Windows 10.

msIsSiteModeFirstRun

Determines whether a pinned site was launched for the first time.

This method is only supported in IE11 on Windows 10.

msPinnedSiteState method

Indicates if the site is pinned, not pinned, or pinned with live tiles turned off.

This method will be supported in Microsoft Edge on Windows 10 in a future update.

msRemoveScheduledTileNotification method

Removes a previously-scheduled notification.

This method will only be supported in Microsoft Edge on Windows 10 in a future update.

msScheduledTileNotification method

Defines one or more non-recurring, scheduled updates.

This method is only supported in Microsoft Edge on Windows 10.

msSiteModeActivate

Flashes the pinned site taskbar button.

This method is only supported in IE11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

msSiteModeAddButtonStyle

Defines an alternate icon image and tooltip for the specified button.

This method is only supported in IE11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

msSiteModeAddJumpListItem

Adds a new entry to the Jump List of a taskbar button.

This method is only supported in IE11 on Windows 10.

msSiteModeAddThumbBarButton

Adds a button to the Thumbnail Toolbar.

This method is only supported in IE11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

msSiteModeClearBadge

Clears the notifications on a pinned site badge in Windows 8.

msSiteModeClearIconOverlay

Removes the icon overlay from the taskbar button.

This method is only supported in IE11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

msSiteModeClearJumpList

Deletes the Jump List.

This method is only supported in IE11 on Windows 10.

msSiteModeCreateJumpList

Creates a new group of items on the Jump List.

This method is only supported in IE11 on Windows 10.

msSiteModeRefreshBadge

Causes Windows 8 to refresh the site tile badge for a webpage to be sure that it is up to date.

msSiteModeSetIconOverlay

Adds an icon overlay to the pinned site taskbar button.

This method is only supported in IE11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

msSiteModeShowButtonStyle

Changes the icon image and tooltip of a Thumbnail Toolbar button.

This method is only supported in IE11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

msSiteModeShowJumpList

Shows updates to the list of items in a Jump List.

This method is only supported in IE11 on Windows 10.

msSiteModeShowThumbBar

Enables the Thumbnail Toolbar in the thumbnail preview of a pinned site.

This method is only supported in IE11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

msSiteModeUpdateThumbBarButton

Changes the state of a Thumbnail Toolbar button.

This method is only supported in IE11 on Windows 10.

This method is not supported for Windows Store apps using JavaScript.

mssitepinned

Fires when a site is pinned to the Start screen.

msStartPeriodicBadgeUpdate method

Starts a badge update for a tile.

This method is only supported in Microsoft Edge on Windows 10.

msStartPeriodicTileUpdate method

Starts a periodic update for a tile.

This method is only supported in Microsoft Edge on Windows 10.

msStartPeriodicTileUpdateBatch method

Starts a set of periodic updates for a tile.

This method is only supported in Microsoft Edge on Windows 10.

msStopPeriodicBadgeUpdate method

Cancels the currently schedule batch of timed badge updates for a tile.

This method is only supported in Microsoft Edge on Windows 10.

msStopPeriodicTileUpdate method

Cancels the currently schedule batch of timed tiles updates.

This method is only supported in Microsoft Edge on Windows 10.

 

Related topics

Pinned site developer documentation
Metadata reference

 

 

Show: