Share via


TabViewCloseButtonOverlayMode Enum

Definition

Defines constants that describe the behavior of the close button contained within each TabViewItem.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

public enum class TabViewCloseButtonOverlayMode
/// [Microsoft.UI.Xaml.CustomAttributes.MUXContractProperty(version=0)]
/// [Windows.Foundation.Metadata.Version(1)]
enum class TabViewCloseButtonOverlayMode
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
enum class TabViewCloseButtonOverlayMode
[Microsoft.UI.Xaml.CustomAttributes.MUXContractProperty(version=0)]
[Windows.Foundation.Metadata.Version(1)]
public enum TabViewCloseButtonOverlayMode
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public enum TabViewCloseButtonOverlayMode
Public Enum TabViewCloseButtonOverlayMode
Inheritance
TabViewCloseButtonOverlayMode
Attributes
Microsoft.UI.Xaml.CustomAttributes.MUXContractPropertyAttribute VersionAttribute ContractVersionAttribute

Fields

Name Value Description
Auto 0

Behavior is defined by the framework. Default.

This value maps to Always.

OnPointerOver 1

The selected tab always shows the close button if it is closable. Unselected tabs show the close button when the tab is closable and the user has their pointer over the tab.

Always 2

The selected tab always shows the close button if it is closable. Unselected tabs always show the close button if they are closable.

Examples

Tip

For more info, design guidance, and code examples, see TabView.

The WinUI 3 Gallery and WinUI 2 Gallery apps include interactive examples of most WinUI 3 and WinUI 2 controls, features, and functionality.

If installed already, open them by clicking the following links: WinUI 3 Gallery or WinUI 2 Gallery.

If they are not installed, you can download the WinUI 3 Gallery and the WinUI 2 Gallery from the Microsoft Store.

You can also get the source code for both from GitHub (use the main branch for WinUI 3 and the winui2 branch for WinUI 2).

Remarks

Selected TabViewItems that are closable always show their close button regardless of the value of the TabViewCloseButtonOverlayMode property. The TabViewCloseButtonOverlayMode only effects the behavior of the unselected TabViewItems.

Applies to

See also