WPF › Ribbon › BinaryRibbonTabItem

BinaryRibbonTabItem

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WPF.Controls.Office

A custom control that renders and works like a tab item as is seen in MS Office Ribbon applications.

public class BinaryRibbonTabItem : Control, IBinaryRibbonKeyTipControl

Inherits from / implements: Control, IBinaryRibbonKeyTipControl

Members at a glance

`BinaryRibbonTabItem`	Initializes a new instance of the `BinaryRibbonTabItem` class.
`AvailableRibbonGroups`	Gets the available ribbon groups.
`BackgroundColor`	Gets the color of the background.
`HeaderText`	Gets or sets the header text for the tab item header area text.
`IsContextualTabItem`	Gets or sets a value indicating whether this instance is contextual tab item.
`IsCurrentlySelected`	Gets or sets a value indicating whether this instance is currently selected.
`LogicalChildren`	Gets the children this element contributes to the logical tree.
`RibbonPanel`	Gets or sets the associated `BinaryRibbonBarPanel` instance.
`SmallImage`	Gets or sets the small image associated with this instance of control.
`EndInit`	Indicates that the initialization process for the element is complete.
`GetImageStretch`	Gets the image stretch.
`OnApplyTemplate`	When overridden in a derived class, is invoked whenever application code or internal processes call `ApplyTemplate`.
`OnKeyDown`	Raises the KeyDown event. BinaryRibbonTabItem overrides it so the control's own handling runs alongside the base behavior.
`OnMouseDoubleClick`	Raises the MouseDoubleClick event. BinaryRibbonTabItem overrides it so the control's own handling runs alongside the base behavior.
`OnMouseLeftButtonDown`	Raises the MouseLeftButtonDown event. BinaryRibbonTabItem overrides it so the control's own handling runs alongside the base behavior.
`SetImageStretch`	Sets the image stretch.
`HeaderTextProperty`	HeaderTextProperty property.
`ImageStretchProperty`	ImageStretchProperty attached property.
`IsContextualTabItemProperty`	IsContextualTabItemProperty property.
`IsCurrentlySelectedProperty`	IsCurrentlySelectedProperty property.
`SmallImageProperty`	SmallImageProperty property.

Constructors

BinaryRibbonTabItem

public BinaryRibbonTabItem() : base()

Initializes a new instance of the BinaryRibbonTabItem class.

Properties

AvailableRibbonGroups

public Collection<BinaryRibbonGroup> AvailableRibbonGroups

Gets the available ribbon groups.

Value. The available ribbon groups.

BackgroundColor

public Color BackgroundColor

Gets the color of the background.

Value. The color of the background.

HeaderText

public string HeaderText

Gets or sets the header text for the tab item header area text.

IsContextualTabItem

public bool IsContextualTabItem

Gets or sets a value indicating whether this instance is contextual tab item.

Value. true if this instance is contextual tab item; otherwise, false .

IsCurrentlySelected

public bool IsCurrentlySelected

Gets or sets a value indicating whether this instance is currently selected.

Value. true if this instance is currently selected; otherwise, false .

LogicalChildren

protected override IEnumerator LogicalChildren

Gets the children this element contributes to the logical tree.

RibbonPanel

public BinaryRibbonBarPanel RibbonPanel

Gets or sets the associated BinaryRibbonBarPanel instance.

Value. The ribbon panel.

SmallImage

public ImageSource SmallImage

Gets or sets the small image associated with this instance of control.

Value. The small image.

Methods

EndInit

public override void EndInit()

Indicates that the initialization process for the element is complete.

InvalidOperationException: EndInit was called without BeginInit having previously been called on the element.

GetImageStretch

public static Stretch GetImageStretch(DependencyObject obj)

Gets the image stretch.

obj: The obj.

OnApplyTemplate

public override void OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate.

OnKeyDown

protected override void OnKeyDown(KeyEventArgs e)

Raises the KeyDown event. BinaryRibbonTabItem overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMouseDoubleClick

protected override void OnMouseDoubleClick(MouseButtonEventArgs e)

Raises the MouseDoubleClick event. BinaryRibbonTabItem overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMouseLeftButtonDown

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Raises the MouseLeftButtonDown event. BinaryRibbonTabItem overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

SetImageStretch

public static void SetImageStretch(DependencyObject obj, Stretch value)

Sets the image stretch.

obj: The obj.
value: The value.

Fields

HeaderTextProperty

public static readonly DependencyProperty HeaderTextProperty

HeaderTextProperty property.

ImageStretchProperty

public static readonly DependencyProperty ImageStretchProperty

ImageStretchProperty attached property.

IsContextualTabItemProperty

public static DependencyProperty IsContextualTabItemProperty

IsContextualTabItemProperty property.

IsCurrentlySelectedProperty

public static readonly DependencyProperty IsCurrentlySelectedProperty

IsCurrentlySelectedProperty property.

SmallImageProperty

public static readonly DependencyProperty SmallImageProperty

SmallImageProperty property.