WPF › Ribbon › BinaryRibbonBarPanel

BinaryRibbonBarPanel

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

BinaryRibbonBarPanel also known as Ribbon bar, is the Ribbon panel control where you can host all ribbon child controls.

public class BinaryRibbonBarPanel : Control

Inherits from / implements: Control

Members at a glance

`BinaryRibbonBarPanel`	Initializes a new instance of the `BinaryRibbonBarPanel` class.
`AlignGroupsLeftCommand`	Gets the "align groups to left" Routed UI command.
`AlignGroupsRightCommand`	Gets the "align groups right" command.
`ApplicationMenu`	Gets or sets the instance of the `BinaryRibbonApplicationMenu`.
`BackgroundColor`	Gets or sets the background color.
`CanMinimize`	Gets or sets a value indicating whether this instance can be minimized.
`CollapseRibbonBarCommand`	Gets the "collapse ribbon bar" command.
`ContextualTabSet`	Gets or sets the contextual tab set.
`ContextualTabSets`	Gets the contextual tab sets.
`CurrentlyVisibleTabItems`	Gets the currently visible tab items.
`IsExpanded`	Gets or sets a value indicating whether this instance is expanded.
`IsMenuOpen`	Gets or sets a value indicating whether the application menu instance is currently open.
`IsMinimized`	Gets or sets a value indicating whether this instance is currently minimized.
`IsRibbonControlVisible`	Gets or sets a value indicating whether this ribbon control instance is visible.
`LogicalChildren`	Gets the children this element contributes to the logical tree.
`QuickAccessToolBar`	Gets or sets the Quick Access Toolbar (QAT) instance.
`SelectedGroups`	Gets or sets the selected groups.
`SelectedTabIndex`	Gets or sets the index of the selected tab.
`SelectedTabItem`	Gets or sets the selected tab item.
`Tabs`	Gets the collection of tabs in the control.
`TitleText`	Gets or sets the window title text.
`ToolbarPlacementLocation`	Gets or sets the toolbar placement location.
`ArrangeOverride`	Places the children within the space this element was given, and reports the space it actually used.
`GetMaxSize`	Gets the maximum size mode.
`GetMinSize`	Gets the minimum size mode.
`GetResizableSize`	Gets the resizable size colection.
`GetSize`	Gets the size mode the control is currently in.
`IndexOfVisibleTab`	A helper method to return the visible index of the given tab item.
`OnApplyTemplate`	When overridden in a derived class, is invoked whenever application code or internal processes call `ApplyTemplate`.
`OnContextualTabSetChanged`	Called when the `ContextualTabSet` dependency property changes.
`OnContextualTabSetsChanged`	Called when the contextual tab sets collection changes, which is where this control brings its layout back in step with its contents.
`OnIsBarExpandedChanged`	Called when the `IsBarExpanded` dependency property changes.
`OnLostKeyboardFocus`	Raises the LostKeyboardFocus event. BinaryRibbonBarPanel overrides it so the control's own handling runs alongside the base behavior.
`OnLostMouseCapture`	Raises the LostMouseCapture event. BinaryRibbonBarPanel overrides it so the control's own handling runs alongside the base behavior.
`OnPopupClose`	Called when this control's drop-down popup closes. Override to react to it without having to attach to the popup yourself.
`OnPopupOpen`	Called when this control's drop-down popup opens. Override to react to it without having to attach to the popup yourself.
`OnPreviewMouseLeftButtonDown`	Raises the PreviewMouseLeftButtonDown event. BinaryRibbonBarPanel overrides it so the control's own handling runs alongside the base behavior.
`OnSelectedGroupsChangedCallback`	Called when the `SelectedGroups` dependency property changes.
`OnSelectedTabIndexChanged`	Called when the `SelectedTabIndex` dependency property changes.
`OnTabItemCollectionChanged`	Called when the tab item collection changes, which is where this control brings its layout back in step with its contents.
`OnVisualParentChanged`	Called when this element is moved to a different visual parent.
`SetGroupRenderingAlignment`	Sets how the groups on the current tab are aligned along the bar. The base does nothing; a derived bar overrides it to lay its groups out its own way.
`SetMaxSize`	Sets the maximum size mode.
`SetMinSize`	Sets the minimum size mode.
`SetResizableSize`	Gets the resizable size colection.
`SetSize`	Sets the size mode the control is currently to be in.
`VisibleTabFromIndex`	A helper method to return the visible tabl item, given an index.
`SelectedTabIndexChanged`	Occurs when selected tab index changes.
`ApplicationMenuProperty`	ApplicationMenuProperty property.
`BackgroundColorProperty`	BackgroundColorProperty property.
`CanMinimizeProperty`	CanMinimizeProperty property.
`ContextualTabSetProperty`	ContextualTabSetProperty property.
`IsExpandedProperty`	IsExpandedProperty property.
`IsMenuOpenProperty`	IsMenuOpenProperty property.
`IsMinimizedProperty`	IsMinimizedProperty property.
`IsRibbonControlVisibleProperty`	IsRibbonControlVisibleProperty property.
`MaxSizeProperty`	MaxSizeProperty attached property.
`MinSizeProperty`	MinSizeProperty attached property.
`QuickAccessToolBarProperty`	QuickAccessToolBarProperty property.
`ResizableSizeProperty`	ResizableSizeProperty attached property.
`SelectedGroupsProperty`	SelectedGroupsProperty property.
`SelectedTabIndexChangedEvent`	SelectedTabIndexChangedEvent Routed event instance.
`SelectedTabIndexProperty`	SelectedTabIndexProperty property.
`SizeProperty`	SizeProperty attached property.
`TitleTextProperty`	TitleTextProperty property.
`ToolbarPlacementLocationProperty`	ToolbarPlacementLocationProperty property.

Constructors

BinaryRibbonBarPanel

public BinaryRibbonBarPanel() : base()

Initializes a new instance of the BinaryRibbonBarPanel class.

Properties

AlignGroupsLeftCommand

public static RoutedUICommand AlignGroupsLeftCommand

Gets the "align groups to left" Routed UI command.

AlignGroupsRightCommand

public static RoutedUICommand AlignGroupsRightCommand

Gets the "align groups right" command.

Value. The align groups right command.

ApplicationMenu

public IBinaryRibbonApplicationMenu ApplicationMenu

Gets or sets the instance of the BinaryRibbonApplicationMenu.

Value. The application menu.

BackgroundColor

public Color BackgroundColor

Gets or sets the background color.

CanMinimize

public bool CanMinimize

Gets or sets a value indicating whether this instance can be minimized.

Value. true if this instance can minimize; otherwise, false .

CollapseRibbonBarCommand

public static RoutedCommand CollapseRibbonBarCommand

Gets the "collapse ribbon bar" command.

Value. The collapse ribbon bar command.

ContextualTabSet

public BinaryRibbonControlContextualTabSet ContextualTabSet

Gets or sets the contextual tab set.

Value. The contextual tab set.

ContextualTabSets

public Collection<BinaryRibbonControlContextualTabSet> ContextualTabSets

Gets the contextual tab sets.

Value. The contextual tab sets.

CurrentlyVisibleTabItems

public IEnumerable<BinaryRibbonTabItem> CurrentlyVisibleTabItems

Gets the currently visible tab items.

Value. The currently visible tab items.

IsExpanded

public bool IsExpanded

Gets or sets a value indicating whether this instance is expanded.

Value. true if this instance is expanded; otherwise, false .

IsMenuOpen

public bool IsMenuOpen

Gets or sets a value indicating whether the application menu instance is currently open.

IsMinimized

public bool IsMinimized

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

Value. true if this instance is minimized; otherwise, false .

IsRibbonControlVisible

public bool IsRibbonControlVisible

Gets or sets a value indicating whether this ribbon control instance is visible.

LogicalChildren

protected override IEnumerator LogicalChildren

Gets the children this element contributes to the logical tree.

QuickAccessToolBar

public BinaryRibbonQuickAccessToolBar QuickAccessToolBar

Gets or sets the Quick Access Toolbar (QAT) instance.

SelectedGroups

public Collection<BinaryRibbonGroup> SelectedGroups

Gets or sets the selected groups.

Value. The selected groups.

SelectedTabIndex

public int SelectedTabIndex

Gets or sets the index of the selected tab.

Value. The index of the selected tab.

SelectedTabItem

public BinaryRibbonTabItem SelectedTabItem

Gets or sets the selected tab item.

Value. The selected tab item.

Tabs

public Collection<BinaryRibbonTabItem> Tabs

Gets the collection of tabs in the control.

TitleText

public object TitleText

Gets or sets the window title text.

Value. The title text.

ToolbarPlacementLocation

public QuickAccessToolbarPlacementLocation ToolbarPlacementLocation

Gets or sets the toolbar placement location.

Value. The toolbar placement location.

Methods

ArrangeOverride

protected override Size ArrangeOverride(Size arrangeBounds)

Places the children within the space this element was given, and reports the space it actually used.

GetMaxSize

public static BinaryRibbonControlSize GetMaxSize(DependencyObject obj)

Gets the maximum size mode.

obj: The obj.

GetMinSize

public static BinaryRibbonControlSize GetMinSize(DependencyObject obj)

Gets the minimum size mode.

GetResizableSize

public static BinaryRibbonControlSizeCollection GetResizableSize(DependencyObject obj)

Gets the resizable size colection.

GetSize

public static BinaryRibbonControlSize GetSize(DependencyObject obj)

Gets the size mode the control is currently in.

IndexOfVisibleTab

public int IndexOfVisibleTab(BinaryRibbonTabItem tabItem)

A helper method to return the visible index of the given tab item.

tabItem: The tab item.

OnApplyTemplate

public override void OnApplyTemplate()

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

OnContextualTabSetChanged

protected virtual void OnContextualTabSetChanged(DependencyPropertyChangedEventArgs e)

Called when the ContextualTabSet dependency property changes.

e: The old and new values of the property.

OnContextualTabSetsChanged

protected virtual void OnContextualTabSetsChanged(object sender, NotifyCollectionChangedEventArgs e)

Called when the contextual tab sets collection changes, which is where this control brings its layout back in step with its contents.

sender: The collection that changed.
e: What was added, removed or moved.

OnIsBarExpandedChanged

protected virtual void OnIsBarExpandedChanged(DependencyPropertyChangedEventArgs e)

Called when the IsBarExpanded dependency property changes.

e: The old and new values of the property.

OnLostKeyboardFocus

protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

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

e: The data for the event.

OnLostMouseCapture

protected override void OnLostMouseCapture(MouseEventArgs e)

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

e: The data for the event.

OnPopupClose

protected virtual void OnPopupClose(object sender, EventArgs e)

Called when this control's drop-down popup closes. Override to react to it without having to attach to the popup yourself.

sender: The popup.
e: Not used.

OnPopupOpen

protected virtual void OnPopupOpen(object sender, EventArgs e)

Called when this control's drop-down popup opens. Override to react to it without having to attach to the popup yourself.

sender: The popup.
e: Not used.

OnPreviewMouseLeftButtonDown

protected override void OnPreviewMouseLeftButtonDown(MouseButtonEventArgs e)

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

e: The data for the event.

OnSelectedGroupsChangedCallback

protected virtual void OnSelectedGroupsChangedCallback(DependencyPropertyChangedEventArgs e)

Called when the SelectedGroups dependency property changes.

e: The old and new values of the property.

OnSelectedTabIndexChanged

protected virtual void OnSelectedTabIndexChanged(DependencyPropertyChangedEventArgs e)

Called when the SelectedTabIndex dependency property changes.

e: The old and new values of the property.

OnTabItemCollectionChanged

protected virtual void OnTabItemCollectionChanged(object sender, System.Collections.Specialized.NotifyCollectionChangedEventArgs e)

Called when the tab item collection changes, which is where this control brings its layout back in step with its contents.

sender: The collection that changed.
e: What was added, removed or moved.

OnVisualParentChanged

protected override void OnVisualParentChanged(DependencyObject oldVisualParent)

Called when this element is moved to a different visual parent.

SetGroupRenderingAlignment

protected virtual void SetGroupRenderingAlignment(BinaryRibbonBarRenderingAlignment alignment)

Sets how the groups on the current tab are aligned along the bar. The base does nothing; a derived bar overrides it to lay its groups out its own way.

alignment: The alignment to apply.

SetMaxSize

public static void SetMaxSize(DependencyObject obj, BinaryRibbonControlSize value)

Sets the maximum size mode.

obj: The obj.
value: The value.

SetMinSize

public static void SetMinSize(DependencyObject obj, BinaryRibbonControlSize value)

Sets the minimum size mode.

SetResizableSize

public static void SetResizableSize(DependencyObject obj, BinaryRibbonControlSizeCollection value)

Gets the resizable size colection.

SetSize

public static void SetSize(DependencyObject obj, BinaryRibbonControlSize value)

Sets the size mode the control is currently to be in.

VisibleTabFromIndex

public BinaryRibbonTabItem VisibleTabFromIndex(int index)

A helper method to return the visible tabl item, given an index.

index: The index.

Events

SelectedTabIndexChanged

public event RoutedEventHandler SelectedTabIndexChanged

Occurs when selected tab index changes.

Fields

ApplicationMenuProperty

public static readonly DependencyProperty ApplicationMenuProperty

ApplicationMenuProperty property.

BackgroundColorProperty

public static readonly DependencyProperty BackgroundColorProperty

BackgroundColorProperty property.

CanMinimizeProperty

public static readonly DependencyProperty CanMinimizeProperty

CanMinimizeProperty property.

ContextualTabSetProperty

public static readonly DependencyProperty ContextualTabSetProperty

ContextualTabSetProperty property.

IsExpandedProperty

public static readonly DependencyProperty IsExpandedProperty

IsExpandedProperty property.

IsMenuOpenProperty

public static readonly DependencyProperty IsMenuOpenProperty

IsMenuOpenProperty property.

IsMinimizedProperty

public static readonly DependencyProperty IsMinimizedProperty

IsMinimizedProperty property.

IsRibbonControlVisibleProperty

public static readonly DependencyProperty IsRibbonControlVisibleProperty

IsRibbonControlVisibleProperty property.

MaxSizeProperty

public static readonly DependencyProperty MaxSizeProperty

MaxSizeProperty attached property.

MinSizeProperty

public static readonly DependencyProperty MinSizeProperty

MinSizeProperty attached property.

QuickAccessToolBarProperty

public static readonly DependencyProperty QuickAccessToolBarProperty

QuickAccessToolBarProperty property.

ResizableSizeProperty

public static readonly DependencyProperty ResizableSizeProperty

ResizableSizeProperty attached property.

SelectedGroupsProperty

public static readonly DependencyProperty SelectedGroupsProperty

SelectedGroupsProperty property.

SelectedTabIndexChangedEvent

public static readonly RoutedEvent SelectedTabIndexChangedEvent

SelectedTabIndexChangedEvent Routed event instance.

SelectedTabIndexProperty

public static readonly DependencyProperty SelectedTabIndexProperty

SelectedTabIndexProperty property.

SizeProperty

public static readonly DependencyProperty SizeProperty

SizeProperty attached property.

TitleTextProperty

public static readonly DependencyProperty TitleTextProperty

TitleTextProperty property.

ToolbarPlacementLocationProperty

public static readonly DependencyProperty ToolbarPlacementLocationProperty

ToolbarPlacementLocationProperty property.