Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

RibbonTabHeader Class

Namespace:
ActiproSoftware.Windows.Controls.Bars.Primitives
Assembly:
ActiproSoftware.Bars.Wpf.dll

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 an instance of the class.

public RibbonTabHeader()

Properties

ContextualTabGroup

The RibbonContextualTabGroup that contains the tab, if any.

public RibbonContextualTabGroup? ContextualTabGroup { get; set; }

Property Value

RibbonContextualTabGroup

CornerRadius

The corner radius of the control's border.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius

IsContentTruncated

Indicates whether content is truncated.

public bool IsContentTruncated { get; }

Property Value

bool:

true if content is truncated; otherwise, false.

IsContextualTab

Indicates whether this is a contextual tab.

public bool IsContextualTab { get; }

Property Value

bool:

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

IsFirstTabInContextualTabGroup

Indicates 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

Indicates 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

Indicates 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

Indicates 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

A string that uniquely identifies the control.

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

Property Value

string

KeyTipText

The key tip text used to access the control.

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

Property Value

string

Label

The text label to display.

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

Property Value

string

MaxPaddingExtent

The maximum padding extent.

public double MaxPaddingExtent { get; set; }

Property Value

double:

The default value is 9.0.

MinPaddingExtent

The minimum padding extent.

public double MinPaddingExtent { get; set; }

Property Value

double:

The default value is 4.0.

ScreenTipFooter

The screen tip footer content.

public object? ScreenTipFooter { get; set; }

Property Value

object

ScreenTipHeader

The screen tip header content.

public object? ScreenTipHeader { get; set; }

Property Value

object

SeparatorOpacity

The separator opacity.

public double SeparatorOpacity { get; }

Property Value

double

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

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

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

Defines the ContextualTabGroup property.

public static readonly DependencyProperty ContextualTabGroupProperty

CornerRadiusProperty

Defines the CornerRadius property.

public static readonly DependencyProperty CornerRadiusProperty

IsContentTruncatedProperty

Defines the IsContentTruncated property.

public static readonly DependencyProperty IsContentTruncatedProperty

IsContextualTabProperty

Defines the IsContextualTab property.

public static readonly DependencyProperty IsContextualTabProperty

IsFirstTabInContextualTabGroupProperty

Defines the IsFirstTabInContextualTabGroup property.

public static readonly DependencyProperty IsFirstTabInContextualTabGroupProperty

IsLastTabInContextualTabGroupProperty

Defines the IsLastTabInContextualTabGroup property.

public static readonly DependencyProperty IsLastTabInContextualTabGroupProperty

IsSelectedProperty

Defines the IsSelected property.

public static readonly DependencyProperty IsSelectedProperty

IsTabContentVisibleProperty

Defines the IsTabContentVisible property.

public static readonly DependencyProperty IsTabContentVisibleProperty

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

MaxPaddingExtentProperty

Defines the MaxPaddingExtent property.

public static readonly DependencyProperty MaxPaddingExtentProperty

MinPaddingExtentProperty

Defines the MinPaddingExtent property.

public static readonly DependencyProperty MinPaddingExtentProperty

ScreenTipFooterProperty

Defines the ScreenTipFooter property.

public static readonly DependencyProperty ScreenTipFooterProperty

ScreenTipHeaderProperty

Defines the ScreenTipHeader property.

public static readonly DependencyProperty ScreenTipHeaderProperty

SeparatorOpacityProperty

Defines the SeparatorOpacity property.

public static readonly DependencyProperty SeparatorOpacityProperty

TitleProperty

Defines the Title property.

public static readonly DependencyProperty TitleProperty

UserInterfaceDensityProperty

Defines the UserInterfaceDensity property.

public static readonly DependencyProperty UserInterfaceDensityProperty

Extension Methods