In This Article

RibbonTabHeader Class

Represents a tab header for a RibbonTabItem, displayed in a ActiproSoftware.Windows.Controls.Bars.Primitives.RibbonTabHeader.Ribbon's tab row.

[TemplatePart(Name = "PART_SelectionElement", Type = typeof(FrameworkElement))]
public class RibbonTabHeader : Control
Inheritance:
object Visual UIElement FrameworkElement Control object

Constructors

RibbonTabHeader()

Initializes a new instance of the RibbonTabHeader class.

public RibbonTabHeader()

Properties

ContextualTabGroup

Gets or sets the RibbonContextualTabGroup that contains the tab, if any.

public RibbonContextualTabGroup ContextualTabGroup { get; set; }

Property Value

RibbonContextualTabGroup:

The RibbonContextualTabGroup that contains the tab, if any.

CornerRadius

Gets or sets the corner radius of the control's border.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius:

The corner radius of the control's border.

IsContentTruncated

Gets whether content is truncated.

public bool IsContentTruncated { get; }

Property Value

bool:

true if content is truncated; otherwise, false.

IsContextualTab

Gets whether this is a contextual tab.

public bool IsContextualTab { get; }

Property Value

bool:

true if this is a contextual tab; otherwise, false.

IsFirstTabInContextualTabGroup

Gets or sets whether this is the first tab in a contextual tab group.

public bool IsFirstTabInContextualTabGroup { get; set; }

Property Value

bool:

true if this is the first tab in a contextual tab group; otherwise, false. The default value is false.

IsLastTabInContextualTabGroup

Gets or sets whether this is the last tab in a contextual tab group.

public bool IsLastTabInContextualTabGroup { get; set; }

Property Value

bool:

true if this is the last tab in a contextual tab group; otherwise, false. The default value is false.

IsSelected

Gets or sets whether the tab is selected.

public bool IsSelected { get; set; }

Property Value

bool:

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

IsTabContentVisible

Gets whether the tab's content is visible.

public bool IsTabContentVisible { get; }

Property Value

bool:

true if the tab's content is visible; 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

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

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

string:

The text label to display.

MaxPaddingExtent

Gets or sets the maximum padding extent.

public double MaxPaddingExtent { get; set; }

Property Value

double:

The maximum padding extent. The default value is 9.0.

MinPaddingExtent

Gets or sets the minimum padding extent.

public double MinPaddingExtent { get; set; }

Property Value

double:

The minimum padding extent. The default value is 4.0.

ScreenTipFooter

Gets or sets the screen tip footer content.

public object ScreenTipFooter { get; set; }

Property Value

object:

The screen tip footer content.

ScreenTipHeader

Gets or sets the screen tip header content.

public object ScreenTipHeader { get; set; }

Property Value

object:

The screen tip header content.

SeparatorOpacity

Gets the separator opacity.

public double SeparatorOpacity { get; }

Property Value

double:

The separator opacity.

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

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

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.

OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.GotKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)
Parameter Type Description
e KeyboardFocusChangedEventArgs

The KeyboardFocusChangedEventArgs that contains the event data.

OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs)

Invoked just before the IsKeyboardFocusWithinChanged event is raised by this element. Implement this method to add class handling for this event.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)
Parameter Type Description
e DependencyPropertyChangedEventArgs

A System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnKeyDown(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.KeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

protected override void OnKeyDown(KeyEventArgs e)
Parameter Type Description
e KeyEventArgs

The KeyEventArgs that contains the event data.

OnKeyTipInvoked(KeyTipInvokedEventArgs)

Occurs when the control's key tip is invoked.

protected virtual void OnKeyTipInvoked(KeyTipInvokedEventArgs e)
Parameter Type Description
e KeyTipInvokedEventArgs

The KeyTipInvokedEventArgs containing data related to this event.

OnKeyTipOpening(KeyTipOpeningEventArgs)

Occurs when the control's key tip is opening.

protected virtual void OnKeyTipOpening(KeyTipOpeningEventArgs e)
Parameter Type Description
e KeyTipOpeningEventArgs

The KeyTipOpeningEventArgs containing data related to this event.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Invoked when an unhandled MouseLeftButtonDown routed event is raised on this element. Implement this method to add class handling for this event.

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameter Type Description
e MouseButtonEventArgs

The MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was pressed.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked whenever the effective value of any dependency property on this FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides System.Windows.DependencyObject.OnPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs).

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameter Type Description
e DependencyPropertyChangedEventArgs

The event data that describes the property that changed, as well as old and new values.

OnToolTipOpening(ToolTipEventArgs)

Invoked whenever the ToolTipOpening routed event reaches this class in its route. Implement this method to add class handling for this event.

protected override void OnToolTipOpening(ToolTipEventArgs e)
Parameter Type Description
e ToolTipEventArgs

Provides data about the event.

ToString()

Returns the string representation of this object.

public override string ToString()

Returns

string:

The string representation of this object.

Fields

ContextualTabGroupProperty

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

public static readonly DependencyProperty ContextualTabGroupProperty

CornerRadiusProperty

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

public static readonly DependencyProperty CornerRadiusProperty

IsContentTruncatedProperty

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

public static readonly DependencyProperty IsContentTruncatedProperty

IsContextualTabProperty

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

public static readonly DependencyProperty IsContextualTabProperty

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

IsSelectedProperty

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

public static readonly DependencyProperty IsSelectedProperty

IsTabContentVisibleProperty

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

public static readonly DependencyProperty IsTabContentVisibleProperty

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

MaxPaddingExtentProperty

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

public static readonly DependencyProperty MaxPaddingExtentProperty

MinPaddingExtentProperty

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

public static readonly DependencyProperty MinPaddingExtentProperty

ScreenTipFooterProperty

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

public static readonly DependencyProperty ScreenTipFooterProperty

ScreenTipHeaderProperty

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

public static readonly DependencyProperty ScreenTipHeaderProperty

SeparatorOpacityProperty

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

public static readonly DependencyProperty SeparatorOpacityProperty

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