RibbonTabItem Class
Represents a tab control within a ActiproSoftware.Windows.Controls.Bars.RibbonTabItem.Ribbon.
[TemplatePart(Name = "PART_OverflowButton", Type = typeof(RibbonTabItemOverflowButton))]
[TemplatePart(Name = "PART_OverflowPresenter", Type = typeof(OverflowPresenter))]
public class RibbonTabItem : ItemsControl, IOrientedElement
- Inheritance:
- object Visual UIElement FrameworkElement Control ItemsControl object
- Implements:
- IOrientedElement
Constructors
RibbonTabItem()
Initializes an instance of the class.
public RibbonTabItem()
Properties
ContextualTabGroup
The RibbonContextualTabGroup that owns this tab, if this is a contextual tab.
public RibbonContextualTabGroup? ContextualTabGroup { get; }
Property Value
See Also
ContextualTabGroupKey
The string key of the related contextual tab group, if this should be a contextual tab.
[Localizability(LocalizationCategory.NeverLocalize)]
public string? ContextualTabGroupKey { get; set; }
Property Value
ControlVariants
The collection of variant size transitions to apply to all controls within the tab when the ribbon is in Simplified layout mode.
GroupLabelMode
The RibbonGroupLabelMode that specifies when a RibbonGroup is labeled.
public RibbonGroupLabelMode GroupLabelMode { get; }
Property Value
- RibbonGroupLabelMode:
The default value is Default.
GroupVariants
The collection of variant size transitions to apply to all groups within the tab when the ribbon is in Classic layout mode.
HeaderToolTip
The tooltip for the tab header.
IsFirstTabInContextualTabGroup
Indicates whether this is the first tab in a ContextualTabGroup.
public bool IsFirstTabInContextualTabGroup { get; }
Property Value
- bool:
trueif this is the first tab in a ContextualTabGroup; otherwise,false.
IsLastTabInContextualTabGroup
Indicates whether this is the last tab in a ContextualTabGroup.
public bool IsLastTabInContextualTabGroup { get; }
Property Value
- bool:
trueif this is the last tab in a ContextualTabGroup; otherwise,false.
IsOverflowButtonVisible
Indicates whether the overflow button is visible.
public bool IsOverflowButtonVisible { get; }
Property Value
- bool:
trueif the overflow button is visible; otherwise,false.
IsSelected
Indicates whether the tab is currently selected.
public bool IsSelected { get; set; }
Property Value
- bool:
trueif the tab is currently selected; otherwise,false. The default value isfalse.
Key
A string that uniquely identifies the control.
[Localizability(LocalizationCategory.NeverLocalize)]
public string? Key { get; set; }
Property Value
KeyTipText
The key tip text used to access the control.
[Localizability(LocalizationCategory.Label)]
public string? KeyTipText { get; set; }
Property Value
Label
The text label to display.
[Localizability(LocalizationCategory.Label)]
public string? Label { get; set; }
Property Value
LayoutMode
A RibbonLayoutMode indicating the layout mode in use.
OverflowButtonToolTip
The tooltip for the overflow button.
Title
The string title, which can override the Label when displayed in screen tips and customization UI.
[Localizability(LocalizationCategory.Title)]
public string? Title { get; set; }
Property Value
- string:
The string title.
UserInterfaceDensity
A UserInterfaceDensity that indicates how compact or spacious the UI should appear.
public UserInterfaceDensity UserInterfaceDensity { get; set; }
Property Value
- UserInterfaceDensity:
The default value is Compact.
Methods
ClearContainerForItemOverride(DependencyObject, object)
When overridden in a derived class, undoes the effects of the PrepareContainerForItemOverride(DependencyObject, object) method.
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
| Parameter | Type | Description |
|---|---|---|
| element | DependencyObject | The container element. |
| item | object | The item. |
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
protected override DependencyObject GetContainerForItemOverride()
Returns
- DependencyObject:
The element that is used to display the given item.
IsItemItsOwnContainerOverride(object)
Determines if the specified item is (or is eligible to be) its own container.
protected override bool IsItemItsOwnContainerOverride(object item)
| Parameter | Type | Description |
|---|---|---|
| item | object | The item to check. |
Returns
- bool:
trueif the item is (or is eligible to be) its own container; otherwise,false.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
protected override AutomationPeer OnCreateAutomationPeer()
Returns
- AutomationPeer:
The type-specific AutomationPeer implementation.
PrepareContainerForItemOverride(DependencyObject, object)
Prepares the specified element to display the specified item.
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
| Parameter | Type | Description |
|---|---|---|
| element | DependencyObject | Element used to display the specified item. |
| item | object | Specified item. |
ToString()
Returns the string representation of this object.
Fields
ContextualTabGroupKeyProperty
Defines the ContextualTabGroupKey property.
public static readonly DependencyProperty ContextualTabGroupKeyProperty
ContextualTabGroupProperty
Defines the ContextualTabGroup property.
public static readonly DependencyProperty ContextualTabGroupProperty
ControlVariantsProperty
Defines the ControlVariants property.
public static readonly DependencyProperty ControlVariantsProperty
GroupLabelModeProperty
Defines the GroupLabelMode property.
public static readonly DependencyProperty GroupLabelModeProperty
GroupVariantsProperty
Defines the GroupVariants property.
public static readonly DependencyProperty GroupVariantsProperty
HeaderToolTipProperty
Defines the HeaderToolTip property.
public static readonly DependencyProperty HeaderToolTipProperty
IsFirstTabInContextualTabGroupProperty
Defines the IsFirstTabInContextualTabGroup property.
public static readonly DependencyProperty IsFirstTabInContextualTabGroupProperty
IsLastTabInContextualTabGroupProperty
Defines the IsLastTabInContextualTabGroup property.
public static readonly DependencyProperty IsLastTabInContextualTabGroupProperty
IsOverflowButtonVisibleProperty
Defines the IsOverflowButtonVisible property.
public static readonly DependencyProperty IsOverflowButtonVisibleProperty
IsSelectedProperty
Defines the IsSelected property.
public static readonly DependencyProperty IsSelectedProperty
KeyProperty
Defines the Key property.
public static readonly DependencyProperty KeyProperty
KeyTipTextProperty
Defines the KeyTipText property.
public static readonly DependencyProperty KeyTipTextProperty
LabelProperty
Defines the Label property.
public static readonly DependencyProperty LabelProperty
LayoutModeProperty
Defines the LayoutMode property.
public static readonly DependencyProperty LayoutModeProperty
OverflowButtonToolTipProperty
Defines the OverflowButtonToolTip property.
public static readonly DependencyProperty OverflowButtonToolTipProperty
RibbonProperty
Defines the RootBarControl property.
public static readonly DependencyProperty RibbonProperty
TitleProperty
Defines the Title property.
public static readonly DependencyProperty TitleProperty
UserInterfaceDensityProperty
Defines the UserInterfaceDensity property.
public static readonly DependencyProperty UserInterfaceDensityProperty