msSiteModeSetIconOverlay method

Adds an icon overlay to the pinned site taskbar button.

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

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

Internet Explorer 9



object.msSiteModeSetIconOverlay(iconUrl, description)


iconUrl [in]

Type: String =

Absolute URL of an icon resource file.

description [in, optional]

Type: String

A String that provides an accessible description of the icon overlay.

Return value

This method does not return a value.

Standards information

There are no standards that apply here.


This method creates an icon overlay that you can use to communicate alerts, notifications, and application status to users. Call msSiteModeClearIconOverlay to remove the overlay. The description parameter provides an accessible description (Microsoft UI Automation "HelpText") of the information conveyed by the icon overlay.

The icon resource file must contain a 16x16 icon at 96 dots per inch (dpi). If an icon overlay is already applied, the existing overlay is replaced.

Note  To view the icon overlay, the taskbar buttons must be in their default large icon mode. Small taskbar icons do not support icon overlays.

See also




© 2016 Microsoft