WPF › Ribbon › BinaryRibbonGroup

BinaryRibbonGroup

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

A custom control class that acts like a "grouping" container for a set of Framework elements.

public class BinaryRibbonGroup : Control, IBinaryRibbonComponentCanRenderInReducedSizeState, IBinaryRibbonComponentCanDisplayImage, IBinaryRibbonKeyTipControl

Inherits from / implements: Control, IBinaryRibbonComponentCanRenderInReducedSizeState, IBinaryRibbonComponentCanDisplayImage, IBinaryRibbonKeyTipControl

Members at a glance

`BinaryRibbonGroup`	Initializes a new instance of the `BinaryRibbonGroup` class.
`CanShowModalDialog`	Gets or sets a value indicating whether this instance can show modal dialog.
`Controls`	Gets the child controls collection.
`Image`	Gets or sets the image.
`IsDropDownActive`	Gets or sets a value indicating whether drop-down window is active.
`IsMinimized`	Gets or sets a value indicating whether this instance is minimized.
`IsTitleTextPaneVisible`	Gets or sets whether to render the title text area.
`ItemsPanel`	Gets or sets the panel control for the items.
`LogicalChildren`	Gets the children this element contributes to the logical tree.
`ModalDialogLaunchCommand`	Gets the modal dialog launch command.
`ResizingDepth`	Gets or sets the resizing depth.
`TitleText`	Gets or sets the title text.
`ToolTipContent`	Gets or sets the content for the super tooltip display.
`CollapseResizingLevel`	Collapses the resizing level.
`DeterministicCloseCurrentOpenPopup`	A helper method to let deterministically close the currently open group popup window.
`ExpandResizingLevel`	Expands the resizing level.
`OnApplyTemplate`	When overridden in a derived class, is invoked whenever application code or internal processes call `ApplyTemplate`.
`OnControlCollectionChanged`	Called when the control collection changes, which is where this control brings its layout back in step with its contents.
`OnExecuteModalDialogLauncher`	Called when the small launcher button in the corner of the group is clicked, which is the ribbon convention for opening the full dialog behind a group.
`OnItemsPanelChanged`	Called when the `ItemsPanel` dependency property changes.
`OnLostKeyboardFocus`	Raises the LostKeyboardFocus event. BinaryRibbonGroup overrides it so the control's own handling runs alongside the base behavior.
`ResetGroupSize`	Resets the size/depth of the group to defaults - i.e. to 0.
`ExecuteModalDialogLauncher`	Occurs when the modal dialog launcher button is clicked.
`CanShowModalDialogProperty`	CanShowModalDialogProperty property.
`ExecuteModalDialogLauncherEvent`	An event that gets raised when the modal dialog launcher button is clicked.
`ImageProperty`	ImageProperty property.
`IsDropDownActiveProperty`	IsDropDownActiveProperty property.
`IsMinimizedProperty`	IsMinimizedProperty property.
`IsTitleTextPaneVisibleProperty`	Identifies the `IsTitleTextPaneVisible` dependency property.
`ItemsPanelProperty`	ItemsPanelProperty property.
`TitleTextProperty`	TitleTextProperty property.
`ToolTipContentProperty`	ToolTipContentProperty property.

Constructors

BinaryRibbonGroup

public BinaryRibbonGroup() : base()

Initializes a new instance of the BinaryRibbonGroup class.

Properties

CanShowModalDialog

public bool CanShowModalDialog

Gets or sets a value indicating whether this instance can show modal dialog.

Value. true if this instance can show modal dialog; otherwise, false .

Controls

public Collection<UIElement> Controls

Gets the child controls collection.

Image

public ImageSource Image

Gets or sets the image.

Value. The image.

IsDropDownActive

public bool IsDropDownActive

Gets or sets a value indicating whether drop-down window is active.

IsMinimized

public bool IsMinimized

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

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

IsTitleTextPaneVisible

public bool IsTitleTextPaneVisible

Gets or sets whether to render the title text area.

ItemsPanel

public Panel ItemsPanel

Gets or sets the panel control for the items.

LogicalChildren

protected override System.Collections.IEnumerator LogicalChildren

Gets the children this element contributes to the logical tree.

ModalDialogLaunchCommand

public static RoutedUICommand ModalDialogLaunchCommand

Gets the modal dialog launch command.

ResizingDepth

public int ResizingDepth

Gets or sets the resizing depth.

Value. The resizing depth.

TitleText

public string TitleText

Gets or sets the title text.

Value. The title text.

ToolTipContent

public object ToolTipContent

Gets or sets the content for the super tooltip display.

Methods

CollapseResizingLevel

public bool CollapseResizingLevel()

Collapses the resizing level.

DeterministicCloseCurrentOpenPopup

public static void DeterministicCloseCurrentOpenPopup()

A helper method to let deterministically close the currently open group popup window.

ExpandResizingLevel

public bool ExpandResizingLevel()

Expands the resizing level.

OnApplyTemplate

public override void OnApplyTemplate()

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

OnControlCollectionChanged

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

Called when the control 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.

OnExecuteModalDialogLauncher

protected virtual void OnExecuteModalDialogLauncher(object sender, RoutedEventArgs e)

Called when the small launcher button in the corner of the group is clicked, which is the ribbon convention for opening the full dialog behind a group.

sender: The launcher button.
e: The routed event data.

OnItemsPanelChanged

protected virtual void OnItemsPanelChanged(DependencyPropertyChangedEventArgs e)

Called when the ItemsPanel dependency property changes.

e: The old and new values of the property.

OnLostKeyboardFocus

protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

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

e: The data for the event.

ResetGroupSize

public void ResetGroupSize()

Resets the size/depth of the group to defaults - i.e. to 0.

Events

ExecuteModalDialogLauncher

public event RoutedEventHandler ExecuteModalDialogLauncher

Occurs when the modal dialog launcher button is clicked.

Fields

CanShowModalDialogProperty

public static readonly DependencyProperty CanShowModalDialogProperty

CanShowModalDialogProperty property.

ExecuteModalDialogLauncherEvent

public static readonly RoutedEvent ExecuteModalDialogLauncherEvent

An event that gets raised when the modal dialog launcher button is clicked.

ImageProperty

public static readonly DependencyProperty ImageProperty

ImageProperty property.

IsDropDownActiveProperty

public static readonly DependencyProperty IsDropDownActiveProperty

IsDropDownActiveProperty property.

IsMinimizedProperty

public static readonly DependencyProperty IsMinimizedProperty

IsMinimizedProperty property.

IsTitleTextPaneVisibleProperty

public static readonly DependencyProperty IsTitleTextPaneVisibleProperty

Identifies the IsTitleTextPaneVisible dependency property.

ItemsPanelProperty

public static readonly DependencyProperty ItemsPanelProperty

ItemsPanelProperty property.

TitleTextProperty

public static readonly DependencyProperty TitleTextProperty

TitleTextProperty property.

ToolTipContentProperty

public static readonly DependencyProperty ToolTipContentProperty

ToolTipContentProperty property.