RibbonTabItem Class

[TemplatePart(Name = "PART_OverflowButton", Type = typeof(RibbonTabItemOverflowButton))]
[TemplatePart(Name = "PART_OverflowPresenter", Type = typeof(OverflowPresenter))]
public class RibbonTabItem : ItemsControl, IOrientedElement

public RibbonTabItem()

public RibbonContextualTabGroup ContextualTabGroup { get; }

Property Value

RibbonContextualTabGroup:

The RibbonContextualTabGroup that owns this tab, if this is a contextual tab

See Also

• ContextualTabGroupKey

[Localizability(LocalizationCategory.NeverLocalize)]
public string ContextualTabGroupKey { get; set; }

Property Value

string:

The string key of the related contextual tab group, if this should be a contextual tab.

public VariantCollection ControlVariants { get; set; }

Property Value

VariantCollection:

The collection of variant size transitions to apply to all controls within the tab when the ribbon is in Simplified layout mode.

public RibbonGroupLabelMode GroupLabelMode { get; }

Property Value

RibbonGroupLabelMode:

The RibbonGroupLabelMode that specifies when a RibbonGroup is labeled. The default value is Default.

public VariantCollection GroupVariants { get; set; }

Property Value

VariantCollection:

The collection of variant size transitions to apply to all groups within the tab when the ribbon is in Classic layout mode.

public object HeaderToolTip { get; set; }

Property Value

object:

The tooltip for the tab header.

public bool IsFirstTabInContextualTabGroup { get; }

Property Value

bool:

true if this is the first tab in a ContextualTabGroup; otherwise, false.

public bool IsLastTabInContextualTabGroup { get; }

Property Value

bool:

true if this is the last tab in a ContextualTabGroup; otherwise, false.

public bool IsOverflowButtonVisible { get; }

Property Value

bool:

true if the overflow button is visible; otherwise, false.

public bool IsSelected { get; set; }

Property Value

bool:

true if the tab is currently selected; otherwise, false. The default value is false.

[Localizability(LocalizationCategory.NeverLocalize)]
public string Key { get; set; }

Property Value

string:

A string that uniquely identifies the control.

[Localizability(LocalizationCategory.Label)]
public string KeyTipText { get; set; }

Property Value

string:

The key tip text used to access the control.

[Localizability(LocalizationCategory.Label)]
public string Label { get; set; }

Property Value

string:

The text label to display.

public RibbonLayoutMode LayoutMode { get; set; }

Property Value

RibbonLayoutMode:

A RibbonLayoutMode indicating the layout mode in use.

public object OverflowButtonToolTip { get; set; }

Property Value

object:

The tooltip for the overflow button.

[Localizability(LocalizationCategory.Title)]
public string Title { get; set; }

Property Value

string:

The string title.

public UserInterfaceDensity UserInterfaceDensity { get; set; }

Property Value

UserInterfaceDensity:

A UserInterfaceDensity that indicates how compact or spacious the UI should appear. The default value is Compact.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The container element.
item	object	The item.

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	The item to check.

Returns

bool:

true if the item is (or is eligible to be) its own container; otherwise, false.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	Element used to display the specified item.
item	object	Specified item.

public override string ToString()

Returns

string:

The string representation of this object.

public static readonly DependencyProperty ContextualTabGroupKeyProperty

public static readonly DependencyProperty ContextualTabGroupProperty

public static readonly DependencyProperty ControlVariantsProperty

public static readonly DependencyProperty GroupLabelModeProperty

public static readonly DependencyProperty GroupVariantsProperty

public static readonly DependencyProperty HeaderToolTipProperty

public static readonly DependencyProperty IsFirstTabInContextualTabGroupProperty

public static readonly DependencyProperty IsLastTabInContextualTabGroupProperty

public static readonly DependencyProperty IsOverflowButtonVisibleProperty

public static readonly DependencyProperty IsSelectedProperty

public static readonly DependencyProperty KeyProperty

public static readonly DependencyProperty KeyTipTextProperty

public static readonly DependencyProperty LabelProperty

public static readonly DependencyProperty LayoutModeProperty

public static readonly DependencyProperty OverflowButtonToolTipProperty

public static readonly DependencyProperty RibbonProperty

public static readonly DependencyProperty TitleProperty

public static readonly DependencyProperty UserInterfaceDensityProperty