AdvancedTabControl Class

[TemplatePart(Name = "PART_MenuButton", Type = typeof(PopupButton))]
[TemplatePart(Name = "PART_NewTabButton", Type = typeof(NewTabButton))]
[TemplatePart(Name = "PART_SelectedContentHost", Type = typeof(ContentPresenter))]
[TemplateVisualState(Name = "TabStripBottom", GroupName = "TabStripPlacementStates")]
[TemplateVisualState(Name = "TabStripLeft", GroupName = "TabStripPlacementStates")]
[TemplateVisualState(Name = "TabStripRight", GroupName = "TabStripPlacementStates")]
[TemplateVisualState(Name = "TabStripTop", GroupName = "TabStripPlacementStates")]
public class AdvancedTabControl : TabControl

public AdvancedTabControl()

public bool AreScrollButtonsVisible { get; }

Property Value

bool:

true if the scroll buttons are visible; otherwise, false. The default value is false.

public bool AreTabEmbeddedButtonsAlwaysVisible { get; set; }

Property Value

bool:

true if tab embedded buttons are always visible, even when the tab is unselected; otherwise, false. The default value is false.

public bool CanScrollBackward { get; }

Property Value

bool:

true if scrolling backward is supported; otherwise, false. The default value is false.

public bool CanScrollForward { get; }

Property Value

bool:

true if scrolling forward is supported; otherwise, false. The default value is false.

public bool CanTabsCloseOnMiddleClick { get; set; }

Property Value

bool:

true if tabs can close when a middle-click is performed over them; otherwise, false. The default value is false.

Remarks

The CanClose property must also be set to true for this behavior to work.

public bool CanTabsDrag { get; set; }

Property Value

bool:

true if the dragging of tabs to reorder is enabled; otherwise, false. The default value is false.

public bool CanTabsHighlightOnPointerOverWhenInactive { get; set; }

Property Value

bool:

true if tabs can highlight when the pointer is over inactive ones; otherwise, false. The default value is false.

public bool CanTabsPin { get; set; }

Property Value

bool:

true if tabs display an embedded pin button; otherwise, false. The default value is false.

public bool CanTabsPromote { get; set; }

Property Value

bool:

true if tabs display an embedded promote from preview layout kind button; otherwise, false. The default value is true.

public bool CanTabsSelectOnDragOver { get; set; }

Property Value

bool:

true if tabs can be selected when performing a system (e.g. text, file) drag over them; otherwise, false. The default value is true.

public Style EmbeddedButtonStyle { get; set; }

Property Value

Style:

The Style to use for embedded buttons.

public bool HasNewTabButton { get; set; }

Property Value

bool:

true if a new tab button is visible; otherwise, false. The default value is false.

public bool HasTabCloseButtons { get; set; }

Property Value

bool:

true if tabs have an embedded close button; otherwise, false. The default value is false.

Remarks

The CanClose property must also be set to true for the button to show.

public bool HasTabImages { get; set; }

Property Value

bool:

true if tabs display an embedded image when one is available; otherwise, false. The default value is false.

public Brush HeaderBackground { get; set; }

Property Value

Brush:

The background Brush for the header area behind the tabs and buttons.

public Brush HighlightBrushActive { get; set; }

Property Value

Brush:

The Brush to use for rendering an active highlight effect around the content border.

public Brush HighlightBrushInactive { get; set; }

Property Value

Brush:

The Brush to use for rendering an inactive highlight effect around the content border. The default value is 0.

public Thickness HighlightThickness { get; set; }

Property Value

Thickness:

The thickness of the highlight effect around the content border. The default value is 0.

public bool IsActive { get; set; }

Property Value

bool:

true if the tab control is active; otherwise, false. The default value is false.

public bool IsLayoutAnimationEnabled { get; set; }

Property Value

bool:

true if animation effects are applied during layout, such as when tabs are added or removed; otherwise, false. The default value is true.

public bool IsMenuButtonVisible { get; }

Property Value

bool:

true if the drop-down menu button is visible; otherwise, false. The default value is false.

public bool IsOverflowed { get; }

Property Value

bool:

true if the tabs are overflowed; otherwise, false.

public bool IsTabContentHorizontal { get; set; }

Property Value

bool:

true if the tab content layout is in a horizontal orientation; otherwise, false. The default value is true.

public bool IsTabKeyboardAccessEnabled { get; set; }

Property Value

bool:

true if keyboard access to directly select a tab is enabled; otherwise, false. The default value is true.

Remarks

When enabled, Ctrl+1 will activate the first tab in a normal state, with Ctrl+2 activating the second normal tab, and so on. Ctrl+Alt+1 will activate the first tab in a pinned state, with Ctrl+Alt+2 activating the second pinned tab, and so on.

public bool IsTabKeyboardSwitchingEnabled { get; set; }

Property Value

bool:

true if keyboard access to switch to the previous/next tab is enabled; otherwise, false. The default value is true.

Remarks

When enabled, Ctrl+Tab will switch to the next tab and Ctrl+Shift+Tab will switch to the previous tab.

public bool IsTabStripVisible { get; set; }

Property Value

bool:

true if the tabstrip is visible; otherwise, false. The default value is true.

public double MaxTabExtent { get; set; }

Property Value

double:

The maximum extent of a tab. The default value is 260.0.

Remarks

Set the MinTabExtent to the same as the MaxTabExtent to produce fixed-size tabs.

public DataTemplate MenuButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the drop-down menu button content.

public double MinTabExtent { get; set; }

Property Value

double:

The minimum extent of a tab. The default value is 30.0.

Remarks

Set the MinTabExtent to the same as the MaxTabExtent to produce fixed-size tabs. This property will be ignored when a TabOverflowBehavior that involves shrinking is active and the tabs enter an overflow scenario.

public Style NewTabButtonStyle { get; set; }

Property Value

Style:

The Style to use for the new tab button.

public DataTemplate OverflowMenuButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the overflow drop-down menu button content.

public ICommand RequestNewTabCommand { get; }

Property Value

ICommand:

The ICommand that can be used to request a new tab.

public Thickness RotatedBorderThickness { get; set; }

Property Value

Thickness:

The BorderThickness value, but automatically rotated based on the TabStripPlacement. The default value is 0.

Remarks

This property should not be set, as it will be set internally.

public Thickness RotatedHighlightThickness { get; set; }

Property Value

Thickness:

The HighlightThickness value, but automatically rotated based on the TabStripPlacement. The default value is 0.

Remarks

This property should not be set, as it will be set internally.

public Thickness RotatedPadding { get; set; }

Property Value

Thickness:

The Padding value, but automatically rotated based on the TabStripPlacement. The default value is 0.

Remarks

This property should not be set, as it will be set internally.

public DataTemplate ScrollBackwardButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the scroll backward content.

public ICommand ScrollBackwardCommand { get; }

Property Value

ICommand:

The ICommand that can be used to scroll backward.

public DataTemplate ScrollForwardButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the scroll forward content.

public ICommand ScrollForwardCommand { get; }

Property Value

ICommand:

The ICommand that can be used to scroll forward.

public double ScrollOffset { get; }

Property Value

double:

The scroll offset.

public ICommand SelectItemCommand { get; }

Property Value

ICommand:

The ICommand that can be used to select an item.

public Brush TabBackground { get; set; }

Property Value

Brush:

The background Brush.

public Brush TabBackgroundActiveSelected { get; set; }

Property Value

Brush:

The background Brush.

public Brush TabBackgroundInactiveSelected { get; set; }

Property Value

Brush:

The background Brush.

public Brush TabBackgroundPointerOver { get; set; }

Property Value

Brush:

The background Brush.

public Brush TabBackgroundPreview { get; set; }

Property Value

Brush:

The background Brush.

public Brush TabBackgroundPreviewActiveSelected { get; set; }

Property Value

Brush:

The background Brush.

public Brush TabBackgroundPreviewPointerOver { get; set; }

Property Value

Brush:

The background Brush.

public Brush TabBorderBrush { get; set; }

Property Value

Brush:

The border Brush.

public Brush TabBorderBrushActiveSelected { get; set; }

Property Value

Brush:

The border Brush.

public Brush TabBorderBrushInactiveSelected { get; set; }

Property Value

Brush:

The border Brush.

public Brush TabBorderBrushPointerOver { get; set; }

Property Value

Brush:

The border Brush.

public Brush TabBorderBrushPreview { get; set; }

Property Value

Brush:

The border Brush.

public Brush TabBorderBrushPreviewActiveSelected { get; set; }

Property Value

Brush:

The border Brush.

public Brush TabBorderBrushPreviewPointerOver { get; set; }

Property Value

Brush:

The border Brush.

public CornerRadius TabCornerRadius { get; set; }

Property Value

CornerRadius:

The corner radius of tab borders, relative to a top-facing tab.

public Style TabEmbeddedButtonStyle { get; set; }

Property Value

Style:

The Style to use for embedded buttons within tabs.

public double TabFarSlantExtent { get; set; }

Property Value

double:

The far side slant extent of the tabs, or 0.0 for no slant. The default value is 0.0.

public Brush TabForeground { get; set; }

Property Value

Brush:

The foreground Brush.

public Brush TabForegroundActiveSelected { get; set; }

Property Value

Brush:

The foreground Brush.

public Brush TabForegroundInactiveSelected { get; set; }

Property Value

Brush:

The foreground Brush.

public Brush TabForegroundPointerOver { get; set; }

Property Value

Brush:

The foreground Brush.

public Brush TabForegroundPreview { get; set; }

Property Value

Brush:

The foreground Brush.

public Brush TabForegroundPreviewActiveSelected { get; set; }

Property Value

Brush:

The foreground Brush.

public Brush TabForegroundPreviewPointerOver { get; set; }

Property Value

Brush:

The foreground Brush.

public double TabNearSlantExtent { get; set; }

Property Value

double:

The near side slant extent of the tabs, or 0.0 for no slant. The default value is 0.0.

public TabOverflowBehavior TabOverflowBehavior { get; set; }

Property Value

TabOverflowBehavior:

The TabOverflowBehavior that indicates the logic to use in tab overflow scenarios. The default value is Shrink.

public Thickness TabPadding { get; set; }

Property Value

Thickness:

The tab padding. The default value is 5,2.

public double TabSpacing { get; set; }

Property Value

double:

The spacing between tabs. The default value is 0.0.

public bool UseDefaultFocusHandling { get; set; }

Property Value

bool:

true if default TabItem focus handling should be used; otherwise, false. The default value is true.

protected override Size ArrangeOverride(Size finalSize)

Parameter	Type	Description
finalSize	Size	The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The System.Windows.DependencyObject that is the wrapper element.
item	object	The item that is being wrapped.

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:

The element that is used to display the given item.

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	Specified item.

Returns

bool:

true if the item is its own item container; otherwise, false.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

An AutomationPeer instance.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The KeyEventArgs that contains the event data.

protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)

Parameter	Type	Description
sizeInfo	SizeChangedInfo	The size change info.

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameter	Type	Description
e	SelectionChangedEventArgs	The SelectionChangedEventArgs containing arguments related to this event.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The System.Windows.DependencyObject that is the wrapper element.
item	object	The item that is being wrapped.

protected virtual void UpdateHighlightBrushes()

Remarks

The default implementation of this method does nothing.

public event EventHandler<AdvancedTabControlMenuEventArgs> MenuOpening

Event Type

EventHandler<AdvancedTabControlMenuEventArgs>

public event EventHandler NewTabRequested

Event Type

EventHandler

public event EventHandler<AdvancedTabItemEventArgs> TabClosing

Event Type

EventHandler<AdvancedTabItemEventArgs>

public event EventHandler<AdvancedTabItemEventArgs> TabDragReordered

Event Type

EventHandler<AdvancedTabItemEventArgs>

public static readonly DependencyProperty AreScrollButtonsVisibleProperty

public static readonly DependencyProperty AreTabEmbeddedButtonsAlwaysVisibleProperty

public static readonly DependencyProperty CanScrollBackwardProperty

public static readonly DependencyProperty CanScrollForwardProperty

public static readonly DependencyProperty CanTabsCloseOnMiddleClickProperty

public static readonly DependencyProperty CanTabsDragProperty

public static readonly DependencyProperty CanTabsHighlightOnPointerOverWhenInactiveProperty

public static readonly DependencyProperty CanTabsPinProperty

public static readonly DependencyProperty CanTabsPromoteProperty

public static readonly DependencyProperty CanTabsSelectOnDragOverProperty

public static readonly DependencyProperty EmbeddedButtonStyleProperty

public static readonly DependencyProperty HasNewTabButtonProperty

public static readonly DependencyProperty HasTabCloseButtonsProperty

public static readonly DependencyProperty HasTabImagesProperty

public static readonly DependencyProperty HeaderBackgroundProperty

public static readonly DependencyProperty HighlightBrushActiveProperty

public static readonly DependencyProperty HighlightBrushInactiveProperty

public static readonly DependencyProperty HighlightThicknessProperty

public static readonly DependencyProperty IsActiveProperty

public static readonly DependencyProperty IsLayoutAnimationEnabledProperty

public static readonly DependencyProperty IsMenuButtonVisibleProperty

public static readonly DependencyProperty IsOverflowedProperty

public static readonly DependencyProperty IsTabContentHorizontalProperty

public static readonly DependencyProperty IsTabKeyboardAccessEnabledProperty

public static readonly DependencyProperty IsTabKeyboardSwitchingEnabledProperty

public static readonly DependencyProperty IsTabStripVisibleProperty

public static readonly DependencyProperty MaxTabExtentProperty

public static readonly DependencyProperty MenuButtonContentTemplateProperty

public static readonly DependencyProperty MinTabExtentProperty

public static readonly DependencyProperty NewTabButtonStyleProperty

public static readonly DependencyProperty OverflowMenuButtonContentTemplateProperty

public static readonly DependencyProperty RotatedBorderThicknessProperty

public static readonly DependencyProperty RotatedHighlightThicknessProperty

public static readonly DependencyProperty RotatedPaddingProperty

public static readonly DependencyProperty ScrollBackwardButtonContentTemplateProperty

public static readonly DependencyProperty ScrollForwardButtonContentTemplateProperty

public static readonly DependencyProperty ScrollOffsetProperty

public static readonly DependencyProperty TabBackgroundActiveSelectedProperty

public static readonly DependencyProperty TabBackgroundInactiveSelectedProperty

public static readonly DependencyProperty TabBackgroundPointerOverProperty

public static readonly DependencyProperty TabBackgroundPreviewActiveSelectedProperty

public static readonly DependencyProperty TabBackgroundPreviewPointerOverProperty

public static readonly DependencyProperty TabBackgroundPreviewProperty

public static readonly DependencyProperty TabBackgroundProperty

public static readonly DependencyProperty TabBorderBrushActiveSelectedProperty

public static readonly DependencyProperty TabBorderBrushInactiveSelectedProperty

public static readonly DependencyProperty TabBorderBrushPointerOverProperty

public static readonly DependencyProperty TabBorderBrushPreviewActiveSelectedProperty

public static readonly DependencyProperty TabBorderBrushPreviewPointerOverProperty

public static readonly DependencyProperty TabBorderBrushPreviewProperty

public static readonly DependencyProperty TabBorderBrushProperty

public static readonly DependencyProperty TabCornerRadiusProperty

public static readonly DependencyProperty TabEmbeddedButtonStyleProperty

public static readonly DependencyProperty TabFarSlantExtentProperty

public static readonly DependencyProperty TabForegroundActiveSelectedProperty

public static readonly DependencyProperty TabForegroundInactiveSelectedProperty

public static readonly DependencyProperty TabForegroundPointerOverProperty

public static readonly DependencyProperty TabForegroundPreviewActiveSelectedProperty

public static readonly DependencyProperty TabForegroundPreviewPointerOverProperty

public static readonly DependencyProperty TabForegroundPreviewProperty

public static readonly DependencyProperty TabForegroundProperty

public static readonly DependencyProperty TabNearSlantExtentProperty

public static readonly DependencyProperty TabOverflowBehaviorProperty

public static readonly DependencyProperty TabPaddingProperty

public static readonly DependencyProperty TabSpacingProperty

public static readonly DependencyProperty UseDefaultFocusHandlingProperty