Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to WindowsTaskbarListMBS class.
WindowsTaskbarListMBS.ActivateTab(WindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The window is not actually activated; the window's item on the taskbar is merely displayed as active.
Lasterror is set.
WindowsTaskbarListMBS.AddTab(WindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Any type of window can be added to the taskbar, but it is recommended that the window at least have the WS_CAPTION style.
Any window added with this method must be removed with the DeleteTab method when the added window is destroyed.
Lasterror is set.
WindowsTaskbarListMBS.DeleteTab(WindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
WindowsTaskbarListMBS.MarkFullscreenWindow(WindowHandle as Integer, Fullscreen as Boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Fullscreen: A Boolean value marking the desired full-screen status of the window.
Setting the value of fFullscreen to TRUE, the Shell treats this window as a full-screen window, and the taskbar is moved to the bottom of the z-order when this window is active. Setting the value of fFullscreen to FALSE removes the full-screen marking, but does not cause the Shell to treat the window as though it were definitely not full-screen. With a FALSEfFullscreen value, the Shell depends on its automatic detection facility to specify how the window should be treated, possibly still flagging the window as full-screen.
Requires Windows XP or Windows Server 2003 or newer.
Lasterror is set.
WindowsTaskbarListMBS.RegisterTab(TabWindowHandle as Integer, MDIWindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
By itself, registering a tab thumbnail alone will not result in its being displayed. You must also call SetTabOrder to instruct the group where to display it.
WindowsTaskbarListMBS.SetActiveAlt(WindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
SetActiveAlt marks the item associated with hwnd as the currently active item for the window's process without changing the pressed state of any item. Any user action that would activate a different tab in that process will activate the tab associated with hwnd instead. The active state of the window's item is not guaranteed to be preserved when the process associated with this window is not active. To ensure that a given tab is always active, call SetActiveAlt whenever any of your windows are activated. Calling SetActiveAlt with a nil window handle clears this state.
WindowsTaskbarListMBS.SetOverlayIcon(TabWindowHandle as Integer, IconHandle as Integer, Description as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
TabWindowHandle:
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.
IconHandle:
The handle of an icon to use as the overlay. This should be a small icon, measuring 16x16 pixels at 96 dpi. If an overlay icon is already applied to the taskbar button, that existing overlay is replaced.
This value can be 0. How a 0 value is handled depends on whether the taskbar button represents a single window or a group of windows.
WindowsTaskbarListMBS.SetProgressState(WindowHandle as Integer, Flags as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Use the ProgressStateFlag* constants. Flags that control the current state of the progress button. Specify only one of the following flags; all states are mutually exclusive of all others.
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
Progress bar information is not shown in high contrast color schemes to guarantee that no accessibility needs are compromised.
Developers accustomed to the existing progress bar control should find the taskbar button progress indicator to be a similar experience both in concept and visuals. Here, the taskbar button itself becomes a progress bar. A taskbar button's progress indicator should be a reflection of a more detailed progress bar in the associated window. This allows the user to see specifics, such as the percentage number and the amount of time remaining, that cannot be shown in a taskbar button. Also, because a taskbar button can show the progress of only a single window in a group, it allows the user to check the progress of individual windows. It also provides progress information to the user when the taskbar button cannot, such as in a high-contrast color scheme.
Note that a taskbar button progress bar is not intended for use with normally peripheral actions such as the loading of a Web page or the printing of a document. That type of progress should continue to be shown in a window's status bar.
The progress indicator is displayed between the taskbar button's icon or text and the background. If progress is shown for both the active taskbar button and an inactive button, shading in the respective progress bars is such that the active button is still obvious to the user. Also, button functionality such as the display of thumbnails continues to work normally when the button is being used to display progress.
When exiting an error or paused state, call this method again with the ProgressStateFlagNormal or ProgressStateFlagIndeterminate flag to continue in the original state or TBPF_NOPROGRESS if the operation is cancelled.
How the Taskbar Button Chooses the Progress Indicator for a Group
The taskbar button can show a progress indicator for only one window at a time. This includes the situation where the taskbar button represents a group and more than one window in that group is broadcasting progress information. In that case, the taskbar button chooses its progress display based on state priority. State priority is shown in the following table with priority 1 being the highest.
Priority | State |
1 | ProgressStateFlagError |
2 | ProgressStateFlagPaused |
3 | ProgressStateFlagNormal |
4 | ProgressStateFlagIndeterminate |
WindowsTaskbarListMBS.SetProgressValue(WindowHandle as Integer, Completed as UInt64, Total as UInt64)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Completed: An application-defined value that indicates the proportion of the operation that has been completed at the time the method is called.
Total: An application-defined value that specifies the value ullCompleted will have when the operation is complete.
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
Determinate Progress Bar Lifecycle
An application first calls SetProgressValue to begin the display of a determinate progress bar, and then calls it again as needed to update the bar as the progress changes. When progress is complete, the application must call SetProgressState with the TBPF_NOPROGRESS flag to dismiss the progress bar.
How the Taskbar Button Chooses the Progress Indicator for a Group
The taskbar button can show a progress indicator for only one window at a time. When the taskbar button represents a group and more than one of the windows in that group are broadcasting progress information, the taskbar button chooses its progress display based on the following state priority.
Priority | State |
1 | ProgressStateFlagError |
2 | ProgressStateFlagPaused |
3 | ProgressStateFlagNormal |
4 | ProgressStateFlagIndeterminate |
WindowsTaskbarListMBS.SetTabActive(TabWindowHandle as Integer, MDIWindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
TabWindowHandle: Handle of the active tab window. This handle must already be registered through RegisterTab. This value can be 0 if no tab is active.
MDIWindowHandle: Handle of the application's main window. This value tells the taskbar which group the thumbnail is a member of. This value is required and cannot be 0.
WindowsTaskbarListMBS.SetTabOrder(TabWindowHandle as Integer, InsertBeforeWindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
TabWindowHandle: The handle of the tab window whose thumbnail is being placed. This value is required, must already be registered through RegisterTab, and cannot be 0.
InsertBeforeWindowHandle: The handle of the tab window whose thumbnail that hwndTab is inserted to the left of. This handle must already be registered through RegisterTab. If this value is 0, the new thumbnail is added to the end of the list.
WindowsTaskbarListMBS.SetTabProperties(TabWindowHandle as Integer, flags as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
An application might want to use the thumbnail or peek representation of its associated parent window if the application cannot generate its own thumbnail for a tab or for its active tab content (such as an animation) to appear live.
flags: One of the TabPropertyFlag* constants.
Available on Windows 7 or Windows Server 2008 R2 or newer.
WindowsTaskbarListMBS.SetThumbnailClip(TabWindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This variant of the method clears the clip that is already in place and return to the default display of the thumbnail.
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
See also:
WindowsTaskbarListMBS.SetThumbnailClip(TabWindowHandle as Integer, x as Integer, y as Integer, w as Integer, h as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
See also:
WindowsTaskbarListMBS.SetThumbnailTooltip(TabWindowHandle as Integer, tip as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
TabWindowHandle: The handle to the window whose thumbnail displays the tooltip. This handle must belong to the calling process.
tip: The text to be displayed in the tooltip. This value can be empty, in which case the title of the window specified by WindowHandle is used as the tooltip.
WindowsTaskbarListMBS.UnregisterTab(TabWindowHandle as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 10.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
It is the responsibility of the calling application to free hwndTab through DestroyWindow. UnregisterTab must be called before the handle is freed.
Requires Windows 7 or Windows Server 2008 R2 or newer.
Lasterror is set.
The items on this page are in the following plugins: MBS Win Plugin.