In This Article

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, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IAddChild, IGeneratorHost, IContainItemStorage, IVariantSizeItemContainer, IOrientedElement, ISupportsCoerceLabel
Inheritance:
System.Object System.Windows.Threading.DispatcherObject System.Windows.DependencyObject System.Windows.Media.Visual System.Windows.UIElement System.Windows.FrameworkElement System.Windows.Controls.Control System.Windows.Controls.ItemsControl Object
Implements:
IOrientedElement

Constructors

RibbonTabItem()

Initializes a new instance of the RibbonTabItem class.

public RibbonTabItem()

Properties

ContextualTabGroup

Gets the RibbonContextualTabGroup that owns this tab, if this is a contextual tab.

public RibbonContextualTabGroup ContextualTabGroup { get; }

Property Value

RibbonContextualTabGroup:

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

See Also

ContextualTabGroupKey

Gets or sets 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

System.String:

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

ControlVariants

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

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.

GroupVariants

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

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.

HeaderToolTip

Gets the tooltip for the tab header.

public object HeaderToolTip { get; set; }

Property Value

System.Object:

The tooltip for the tab header.

IsFirstTabInContextualTabGroup

Gets whether this is the first tab in a ContextualTabGroup.

public bool IsFirstTabInContextualTabGroup { get; }

Property Value

System.Boolean:

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

IsLastTabInContextualTabGroup

Gets whether this is the last tab in a ContextualTabGroup.

public bool IsLastTabInContextualTabGroup { get; }

Property Value

System.Boolean:

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

IsOverflowButtonVisible

Gets whether the overflow button is visible.

public bool IsOverflowButtonVisible { get; }

Property Value

System.Boolean:

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

IsSelected

Gets or sets whether the tab is currently selected.

public bool IsSelected { get; set; }

Property Value

System.Boolean:

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

Key

Gets or sets a string that uniquely identifies the control.

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

Property Value

System.String:

A string that uniquely identifies the control.

KeyTipText

Gets or sets the key tip text used to access the control.

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

Property Value

System.String:

The key tip text used to access the control.

Label

Gets or sets the text label to display.

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

Property Value

System.String:

The text label to display.

LayoutMode

Gets or sets a RibbonLayoutMode indicating the layout mode in use.

public RibbonLayoutMode LayoutMode { get; set; }

Property Value

RibbonLayoutMode:

A RibbonLayoutMode indicating the layout mode in use.

OverflowButtonToolTip

Gets or sets the tooltip for the overflow button.

public object OverflowButtonToolTip { get; set; }

Property Value

System.Object:

The tooltip for the overflow button.

Title

Gets or sets 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

System.String:

The string title.

UserInterfaceDensity

Gets or sets a UserInterfaceDensity that indicates how compact or spacious the UI should appear.

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.

Methods

ClearContainerForItemOverride(DependencyObject, Object)

When overridden in a derived class, undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject, System.Object) method.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameter Type Description
element System.Windows.DependencyObject

The container element.

item System.Object

The item.

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

protected override DependencyObject GetContainerForItemOverride()

Returns

System.Windows.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 System.Object

The item to check.

Returns

System.Boolean:

true if 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 System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer:

The type-specific System.Windows.Automation.Peers.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 System.Windows.DependencyObject

Element used to display the specified item.

item System.Object

Specified item.

ToString()

Provides a string representation of the System.Windows.Controls.ItemsControl object.

public override string ToString()

Returns

System.String:

The string representation of the object.

Explicit Interface Implementations

IOrientedElement.Orientation

Gets the orientation of the element.

Orientation IOrientedElement.Orientation { get; }

Returns

System.Windows.Controls.Orientation:

The orientation of the element.

Fields

ContextualTabGroupKeyProperty

Identifies the ContextualTabGroupKey dependency property. This field is read-only.

public static readonly DependencyProperty ContextualTabGroupKeyProperty

ContextualTabGroupProperty

Identifies the ContextualTabGroup dependency property. This field is read-only.

public static readonly DependencyProperty ContextualTabGroupProperty

ControlVariantsProperty

Identifies the ControlVariants dependency property. This field is read-only.

public static readonly DependencyProperty ControlVariantsProperty

GroupVariantsProperty

Identifies the GroupVariants dependency property. This field is read-only.

public static readonly DependencyProperty GroupVariantsProperty

HeaderToolTipProperty

Identifies the HeaderToolTip dependency property. This field is read-only.

public static readonly DependencyProperty HeaderToolTipProperty

IsFirstTabInContextualTabGroupProperty

Identifies the IsFirstTabInContextualTabGroup dependency property. This field is read-only.

public static readonly DependencyProperty IsFirstTabInContextualTabGroupProperty

IsLastTabInContextualTabGroupProperty

Identifies the IsLastTabInContextualTabGroup dependency property. This field is read-only.

public static readonly DependencyProperty IsLastTabInContextualTabGroupProperty

IsOverflowButtonVisibleProperty

Identifies the IsOverflowButtonVisible dependency property. This field is read-only.

public static readonly DependencyProperty IsOverflowButtonVisibleProperty

IsSelectedProperty

Identifies the IsSelected dependency property. This field is read-only.

public static readonly DependencyProperty IsSelectedProperty

KeyProperty

Identifies the Key dependency property. This field is read-only.

public static readonly DependencyProperty KeyProperty

KeyTipTextProperty

Identifies the KeyTipText dependency property. This field is read-only.

public static readonly DependencyProperty KeyTipTextProperty

LabelProperty

Identifies the Label dependency property. This field is read-only.

public static readonly DependencyProperty LabelProperty

LayoutModeProperty

Identifies the LayoutMode dependency property. This field is read-only.

public static readonly DependencyProperty LayoutModeProperty

OverflowButtonToolTipProperty

Identifies the OverflowButtonToolTip dependency property. This field is read-only.

public static readonly DependencyProperty OverflowButtonToolTipProperty

RibbonProperty

Identifies the ActiproSoftware.Windows.Controls.Bars.RibbonTabItem.Ribbon dependency property. This field is read-only.

public static readonly DependencyProperty RibbonProperty

TitleProperty

Identifies the Title dependency property. This field is read-only.

public static readonly DependencyProperty TitleProperty

UserInterfaceDensityProperty

Identifies the UserInterfaceDensity dependency property. This field is read-only.

public static readonly DependencyProperty UserInterfaceDensityProperty

Inherited Members

  • System.Object.Equals(System.Object)
  • System.Object.Equals(System.Object, System.Object)
  • System.Object.ReferenceEquals(System.Object, System.Object)
  • System.Object.GetHashCode()
  • System.Object.GetType()
  • System.Object.MemberwiseClone()

Extension Methods