WindowTabManager Class

Reference

Definition

Namespace:: Windows.UI.Shell

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Lets an app manage the relationship between its in-app UI tabs and representations of the tabs in the system shell UI.

public ref class WindowTabManager sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.UI.Shell.WindowTabManagerContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class WindowTabManager final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.UI.Shell.WindowTabManagerContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class WindowTabManager

Public NotInheritable Class WindowTabManager

Inheritance: Object Platform::Object IInspectable WindowTabManager

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.23504.0)
API contract	Windows.UI.Shell.WindowTabManagerContract (introduced in v1.0)

Remarks

Important

This API is for Win32 desktop apps only. UWP and other app types are not supported.

If your app uses visual tabs to organize and separate content, you can use WindowTabManager to expose those tabs in system shell UI for easier access.

The WindowTabManager lets an app share information about its in-app tab views to the Windows shell. How the shell chooses to respond to the information, if at all, is at the shell's discretion. (In other words, the implementation may be inert on some shells.)

WindowsTabManager stores the list of tabs the app wants the Windows shell to know about and lets the app indicate which one is the currently active tab. The app can also provide information about the tab's title, icon, grouping, and if they are associated with an alternative application id.

WindowsTabManager also provides events that the app can subscribe to in order to react to Windows shell-triggered interactions with its tabs; for example, switching to a different tab, closing a tab, or knowing that a preview of a tab is displayed.

Properties

Tabs	Gets the collection of tabs managed by this tab manager.

Methods

GetForWindow(WindowId)	Retrieves an instance of `WindowTabManager` associated with the specified window.
IsSupported()	Gets a value that indicates whether tab management is supported by the current system shell.
IsTabTearOutSupported()	Gets a value that indicates whether the current system shell supports tearing a tab out into a separate window.
SetActiveTab(WindowTab)	Notifies the system to make the specified tab the active tab.

Events

TabCloseRequested	Occurs when a tab is closed from a system shell surface.
TabSwitchRequested	Occurs when a tab is switched to from a system shell surface.
TabTearOutRequested	Occurs when the system shell requests a separate window for a specific tab.
TabThumbnailRequested	Occurs when the system shows a tab in a shell surface that displays a thumbnail view, as a signal to the app to generate a current thumbnail.

Applies to

Dela via