Class TaskbarManager

Namespace

Microsoft.WindowsAPICodePack.Taskbar

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

Represents an instance of the Windows taskbar

public class TaskbarManager

Inheritance

object

TaskbarManager

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

ApplicationId

Gets or sets the application user model id. Use this to explicitly set the application id when generating custom jump lists

public string ApplicationId { get; set; }

Property Value

string

Instance

Represents an instance of the Windows Taskbar

public static TaskbarManager Instance { get; }

Property Value

TaskbarManager

IsPlatformSupported

Indicates whether this feature is supported on the current platform.

public static bool IsPlatformSupported { get; }

Property Value

bool

TabbedThumbnail

Gets the Tabbed Thumbnail manager class for adding/updating tabbed thumbnail previews.

public TabbedThumbnailManager TabbedThumbnail { get; }

Property Value

TabbedThumbnailManager

ThumbnailToolBars

Gets the Thumbnail toolbar manager class for adding/updating toolbar buttons.

public ThumbnailToolBarManager ThumbnailToolBars { get; }

Property Value

ThumbnailToolBarManager

Methods

SetApplicationIdForSpecificWindow(nint, string)

Sets the application user model id for an individual window

public void SetApplicationIdForSpecificWindow(nint windowHandle, string appId)

Parameters

windowHandle nint

Window handle for the window that needs a specific application id

appId string

The app id to set

Remarks

AppId specifies a unique Application User Model ID (AppID) for the application or individual top-level window whose taskbar button will hold the custom JumpList built through the methods JumpList class. By setting an appId for a specific window, the window will not be grouped with it's parent window/application. Instead it will have it's own taskbar button.

SetApplicationIdForSpecificWindow(Window, string)

Sets the application user model id for a given window

public void SetApplicationIdForSpecificWindow(Window window, string appId)

Parameters

window Window

Window that needs a specific application id

appId string

The app id to set

Remarks

AppId specifies a unique Application User Model ID (AppID) for the application or individual top-level window whose taskbar button will hold the custom JumpList built through the methods JumpList class. By setting an appId for a specific window, the window will not be grouped with it's parent window/application. Instead it will have it's own taskbar button.

SetOverlayIcon(Icon, string)

Applies an overlay to a taskbar button of the main application window to indicate application status or a notification to the user.

public void SetOverlayIcon(Icon icon, string accessibilityText)

Parameters

icon Icon

The overlay icon

accessibilityText string

String that provides an alt text version of the information conveyed by the overlay, for accessibility purposes

SetOverlayIcon(nint, Icon, string)

Applies an overlay to a taskbar button of the given window handle to indicate application status or a notification to the user.

public void SetOverlayIcon(nint windowHandle, Icon icon, string accessibilityText)

Parameters

windowHandle nint

The handle of the window whose associated taskbar button receives the overlay. This handle must belong to a calling process associated with the button's application and must be a valid HWND or the call is ignored.

icon Icon

The overlay icon

accessibilityText string

String that provides an alt text version of the information conveyed by the overlay, for accessibility purposes

SetOverlayIcon(Window, Icon, string)

Applies an overlay to a taskbar button of the given WPF window to indicate application status or a notification to the user.

public void SetOverlayIcon(Window window, Icon icon, string accessibilityText)

Parameters

window Window

The window whose associated taskbar button receives the overlay. This window belong to a calling process associated with the button's application and must be already loaded.

icon Icon

The overlay icon

accessibilityText string

String that provides an alt text version of the information conveyed by the overlay, for accessibility purposes

SetProgressState(TaskbarProgressBarState)

Sets the type and state of the progress indicator displayed on a taskbar button of the main application window.

public void SetProgressState(TaskbarProgressBarState state)

Parameters

state TaskbarProgressBarState

Progress state of the progress button

SetProgressState(TaskbarProgressBarState, nint)

Sets the type and state of the progress indicator displayed on a taskbar button of the given window handle

public void SetProgressState(TaskbarProgressBarState state, nint windowHandle)

Parameters

state TaskbarProgressBarState

Progress state of the progress button

windowHandle nint

The handle of the window whose associated taskbar button is being used as a progress indicator. This window belong to a calling process associated with the button's application and must be already loaded.

SetProgressState(TaskbarProgressBarState, Window)

Sets the type and state of the progress indicator displayed on a taskbar button of the given WPF window

public void SetProgressState(TaskbarProgressBarState state, Window window)

Parameters

state TaskbarProgressBarState

Progress state of the progress button

window Window

The window whose associated taskbar button is being used as a progress indicator. This window belong to a calling process associated with the button's application and must be already loaded.

SetProgressValue(int, int)

Displays or updates a progress bar hosted in a taskbar button of the main application window to show the specific percentage completed of the full operation.

public void SetProgressValue(int currentValue, int maximumValue)

Parameters

currentValue int

An application-defined value that indicates the proportion of the operation that has been completed at the time the method is called.

maximumValue int

An application-defined value that specifies the value currentValue will have when the operation is complete.

SetProgressValue(int, int, nint)

Displays or updates a progress bar hosted in a taskbar button of the given window handle to show the specific percentage completed of the full operation.

public void SetProgressValue(int currentValue, int maximumValue, nint windowHandle)

Parameters

currentValue int

An application-defined value that indicates the proportion of the operation that has been completed at the time the method is called.

maximumValue int

An application-defined value that specifies the value currentValue will have when the operation is complete.

windowHandle nint

The handle of the window whose associated taskbar button is being used as a progress indicator. This window belong to a calling process associated with the button's application and must be already loaded.

SetProgressValue(int, int, Window)

Displays or updates a progress bar hosted in a taskbar button of the given WPF window to show the specific percentage completed of the full operation.

public void SetProgressValue(int currentValue, int maximumValue, Window window)

Parameters

currentValue int

An application-defined value that indicates the proportion of the operation that has been completed at the time the method is called.

maximumValue int

An application-defined value that specifies the value currentValue will have when the operation is complete.

window Window

The window whose associated taskbar button is being used as a progress indicator. This window belong to a calling process associated with the button's application and must be already loaded.