TaskbarItemInfo.Overlay Property

Gets or sets the image that is displayed over the program icon in the taskbar button.

Namespace:  Microsoft.Windows.Shell
Assembly:  Microsoft.Windows.Shell (in Microsoft.Windows.Shell.dll)

Syntax

'Declaration
Public Property Overlay As ImageSource
public ImageSource Overlay { get; set; }
public:
property ImageSource^ Overlay {
    ImageSource^ get ();
    void set (ImageSource^ value);
}
member Overlay : ImageSource with get, set
function get Overlay () : ImageSource
function set Overlay (value : ImageSource)

Property Value

Type: System.Windows.Media.ImageSource
The image that is displayed over the program icon in the taskbar button. The default is nulla null reference (Nothing in Visual Basic).

Remarks

You can add an image to the program icon in the taskbar button to communicate application status to the user. The overlay uses a static or animated ImageSource that is positioned over the bottom-right corner of the icon in the taskbar button. The overlay is not displayed if the user sets the taskbar to show small icons.

Program icons in the notification area, which is at the far right of the taskbar, are typically used to communicate application status to a user. In Windows 7, program icons in the notification area are hidden by default, and are therefore, less useful for communicating status. You can use the taskbar button overlay in Windows 7 to communicate status when the icon in the notification area is hidden. Your application can detect the version of Windows and provide notifications in a manner that is appropriate for the operating system.

Overlay images are rendered at the appropriate size. If the ImageSource represents an Icon, the appropriate bit depth is also used.

The following illustration shows the taskbar Overlay.

Windows Taskbar Overlay

Taskbar Item Info Sample

.NET Framework Security

See Also

Reference

TaskbarItemInfo Class

Microsoft.Windows.Shell Namespace

Version

OSVersion