Class BinaryRibbonBarPanel

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

Namespace: Binarymission.WPF.Controls.Office

Assembly: Binarymission.WPF.Controls.BinaryRibbon.dll

Syntax

public class BinaryRibbonBarPanel : Control

Constructors

BinaryRibbonBarPanel()

Initializes a new instance of the BinaryRibbonBarPanel class.

Declaration

public BinaryRibbonBarPanel()

Fields

SelectedTabIndexChangedEvent

SelectedTabIndexChangedEvent Routed event instance.

Declaration

public static readonly RoutedEvent SelectedTabIndexChangedEvent

Field Value

Type	Description
RoutedEvent

Properties

AlignGroupsLeftCommand

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

Declaration

public static RoutedUICommand AlignGroupsLeftCommand { get; }

AlignGroupsRightCommand

Gets the "align groups right" command.

Declaration

public static RoutedUICommand AlignGroupsRightCommand { get; }

ApplicationMenu

Gets or sets the instance of the BinaryRibbonApplicationMenu.

Declaration

public IBinaryRibbonApplicationMenu ApplicationMenu { get; set; }

BackgroundColor

Gets or sets the background color.

Declaration

public Color BackgroundColor { get; }

CanMinimize

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

Declaration

public bool CanMinimize { get; set; }

CollapseRibbonBarCommand

Gets the "collapse ribbon bar" command.

Declaration

public static RoutedCommand CollapseRibbonBarCommand { get; }

ContextualTabSet

Gets or sets the contextual tab set.

Declaration

public BinaryRibbonControlContextualTabSet ContextualTabSet { get; set; }

ContextualTabSets

Gets the contextual tab sets.

Declaration

public Collection<BinaryRibbonControlContextualTabSet> ContextualTabSets { get; }

CurrentlyVisibleTabItems

Gets the currently visible tab items.

Declaration

public IEnumerable<BinaryRibbonTabItem> CurrentlyVisibleTabItems { get; }

IsExpanded

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

Declaration

public bool IsExpanded { get; set; }

IsMenuOpen

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

Declaration

public bool IsMenuOpen { get; set; }

IsMinimized

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

Declaration

public bool IsMinimized { get; }

IsRibbonControlVisible

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

Declaration

public bool IsRibbonControlVisible { get; set; }

LogicalChildren

Declaration

protected override IEnumerator LogicalChildren { get; }

QuickAccessToolBar

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

Declaration

public BinaryRibbonQuickAccessToolBar QuickAccessToolBar { get; set; }

SelectedGroups

Gets or sets the selected groups.

Declaration

public Collection<BinaryRibbonGroup> SelectedGroups { get; }

SelectedTabIndex

Gets or sets the index of the selected tab.

Declaration

public int SelectedTabIndex { get; set; }

SelectedTabItem

Gets or sets the selected tab item.

Declaration

public BinaryRibbonTabItem SelectedTabItem { get; set; }

Tabs

Gets the collection of tabs in the control.

Declaration

public Collection<BinaryRibbonTabItem> Tabs { get; }

TitleText

Gets or sets the window title text.

Declaration

public object TitleText { get; set; }

ToolbarPlacementLocation

Gets or sets the toolbar placement location.

Declaration

public QuickAccessToolbarPlacementLocation ToolbarPlacementLocation { get; set; }

Methods

ArrangeOverride(Size)

Declaration

protected override Size ArrangeOverride(Size arrangeBounds)

Parameters

Type	Name	Description
Size	arrangeBounds

Returns

Type	Description
Size

GetMaxSize(DependencyObject)

Gets the maximum size mode.

Declaration

public static BinaryRibbonControlSize GetMaxSize(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj	The obj.

Returns

Type	Description
BinaryRibbonControlSize

GetMinSize(DependencyObject)

Gets the minimum size mode.

Declaration

public static BinaryRibbonControlSize GetMinSize(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
BinaryRibbonControlSize

GetResizableSize(DependencyObject)

Gets the resizable size colection.

Declaration

public static BinaryRibbonControlSizeCollection GetResizableSize(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
BinaryRibbonControlSizeCollection

GetSize(DependencyObject)

Gets the size mode the control is currently in.

Declaration

public static BinaryRibbonControlSize GetSize(DependencyObject obj)

Parameters

Type	Name	Description
DependencyObject	obj

Returns

Type	Description
BinaryRibbonControlSize

IndexOfVisibleTab(BinaryRibbonTabItem)

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

Declaration

public int IndexOfVisibleTab(BinaryRibbonTabItem tabItem)

Parameters

Type	Name	Description
BinaryRibbonTabItem	tabItem	The tab item.

Returns

Type	Description
Int32

OnApplyTemplate()

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

Declaration

public override void OnApplyTemplate()

OnContextualTabSetChanged(DependencyPropertyChangedEventArgs)

Declaration

protected virtual void OnContextualTabSetChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DependencyPropertyChangedEventArgs	e

OnContextualTabSetsChanged(Object, NotifyCollectionChangedEventArgs)

Declaration

protected virtual void OnContextualTabSetsChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

Type	Name	Description
Object	sender
NotifyCollectionChangedEventArgs	e

OnIsBarExpandedChanged(DependencyPropertyChangedEventArgs)

Declaration

protected virtual void OnIsBarExpandedChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DependencyPropertyChangedEventArgs	e

OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)

Declaration

protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameters

Type	Name	Description
KeyboardFocusChangedEventArgs	e

OnLostMouseCapture(MouseEventArgs)

Declaration

protected override void OnLostMouseCapture(MouseEventArgs e)

Parameters

Type	Name	Description
MouseEventArgs	e

OnPopupClose(Object, EventArgs)

Declaration

protected virtual void OnPopupClose(object sender, EventArgs e)

Parameters

Type	Name	Description
Object	sender
EventArgs	e

OnPopupOpen(Object, EventArgs)

Declaration

protected virtual void OnPopupOpen(object sender, EventArgs e)

Parameters

Type	Name	Description
Object	sender
EventArgs	e

OnPreviewMouseLeftButtonDown(MouseButtonEventArgs)

Declaration

protected override void OnPreviewMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

Type	Name	Description
MouseButtonEventArgs	e

OnSelectedGroupsChangedCallback(DependencyPropertyChangedEventArgs)

Declaration

protected virtual void OnSelectedGroupsChangedCallback(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DependencyPropertyChangedEventArgs	e

OnSelectedTabIndexChanged(DependencyPropertyChangedEventArgs)

Declaration

protected virtual void OnSelectedTabIndexChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DependencyPropertyChangedEventArgs	e

OnTabItemCollectionChanged(Object, NotifyCollectionChangedEventArgs)

Declaration

protected virtual void OnTabItemCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

Type	Name	Description
Object	sender
NotifyCollectionChangedEventArgs	e

OnVisualParentChanged(DependencyObject)

Declaration

protected override void OnVisualParentChanged(DependencyObject oldVisualParent)

Parameters

Type	Name	Description
DependencyObject	oldVisualParent

SetGroupRenderingAlignment(BinaryRibbonBarRenderingAlignment)

Declaration

protected virtual void SetGroupRenderingAlignment(BinaryRibbonBarRenderingAlignment alignment)

Parameters

Type	Name	Description
BinaryRibbonBarRenderingAlignment	alignment

SetMaxSize(DependencyObject, BinaryRibbonControlSize)

Sets the maximum size mode.

Declaration

public static void SetMaxSize(DependencyObject obj, BinaryRibbonControlSize value)

Parameters

Type	Name	Description
DependencyObject	obj	The obj.
BinaryRibbonControlSize	value	The value.

SetMinSize(DependencyObject, BinaryRibbonControlSize)

Sets the minimum size mode.

Declaration

public static void SetMinSize(DependencyObject obj, BinaryRibbonControlSize value)

Parameters

Type	Name	Description
DependencyObject	obj
BinaryRibbonControlSize	value

SetResizableSize(DependencyObject, BinaryRibbonControlSizeCollection)

Gets the resizable size colection.

Declaration

public static void SetResizableSize(DependencyObject obj, BinaryRibbonControlSizeCollection value)

Parameters

Type	Name	Description
DependencyObject	obj
BinaryRibbonControlSizeCollection	value

SetSize(DependencyObject, BinaryRibbonControlSize)

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

Declaration

public static void SetSize(DependencyObject obj, BinaryRibbonControlSize value)

Parameters

Type	Name	Description
DependencyObject	obj
BinaryRibbonControlSize	value

VisibleTabFromIndex(Int32)

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

Declaration

public BinaryRibbonTabItem VisibleTabFromIndex(int index)

Parameters

Type	Name	Description
Int32	index	The index.

Returns

Type	Description
BinaryRibbonTabItem

Events

SelectedTabIndexChanged

Occurs when selected tab index changes.

Declaration

public event RoutedEventHandler SelectedTabIndexChanged

Event Type

Type	Description
RoutedEventHandler