Class

RadRibbonBarElement

Initializes a new instance of the RadRibbonBarElement class.

Declaration

public RadRibbonBarElement()

Declaration

public static RadProperty IsBackstageModeProperty

Field Value

Declaration

public static RadProperty IsRibbonFormActiveProperty

Field Value

Declaration

public static RadProperty QuickAccessMenuHeightProperty

Field Value

Declaration

public static RadProperty QuickAccessToolbarBelowRibbonProperty

Field Value

Declaration

public static RadProperty RibbonFormWindowStateProperty

Field Value

Declaration

public static RadProperty SimplifiedHeightProperty

Field Value

Gets the application menu button element.

Declaration

[Browsable(false)]
public RadApplicationMenuButtonElement ApplicationButtonElement { get; }

Property Value

Gets or sets the width of the right column in the application menu.

Declaration

public int ApplicationMenuRightColumnWidth { get; set; }

Property Value

Gets or sets the application menu style for the ribbon bar.

Declaration

public ApplicationMenuStyle ApplicationMenuStyle { get; set; }

Property Value

Gets or sets the backstage control used for the backstage view.

Declaration

public RadRibbonBarBackstageView BackstageControl { get; set; }

Property Value

Gets the stack layout element that contains the buttons in the ribbon bar caption.

Declaration

public StackLayoutElement ButtonsContainer { get; }

Property Value

Gets the BorderPrimitive instance that represents the border of the ribbon's caption.

Declaration

[Browsable(false)]
public BorderPrimitive CaptionBorder { get; }

Property Value

Gets the FillPrimitive instance that represents the fill of the ribbon's caption.

Declaration

[Browsable(false)]
public FillPrimitive CaptionFill { get; }

Property Value

Gets or sets a value indicating whether the close button is visible in the ribbon caption.

Declaration

public bool CloseButton { get; set; }

Property Value

Gets or sets a value indicating whether the ribbon bar will be collapsed or expanded on ribbon tab double click.

Declaration

public bool CollapseRibbonOnTabDoubleClick { get; set; }

Property Value

Gets or sets a boolean value determining whether the groups are collapsed according to the ribbon's size.

Declaration

public bool CollapsingEnabled { get; set; }

Property Value

Gets a collection of the command tabs.

Declaration

[Browsable(true)]
[RadEditItemsAction]
public RadRibbonBarCommandTabCollection CommandTabs { get; }

Property Value

Gets a collection of contextual tab groups.

Declaration

[Browsable(true)]
[RadNewItem("Add New Group...", true, true, false)]
public RadItemOwnerCollection ContextualTabGroups { get; }

Property Value

Gets the exit menu button

Declaration

[Browsable(false)]
public RadMenuButtonItem ExitButton { get; }

Property Value

Gets or sets the ribbon expand/collapse button element.

Declaration

public RadToggleButtonElement ExpandButton { get; set; }

Property Value

Gets or sets a value indicating whether the RadRibbonBarElement is expanded or collapsed.

Declaration

public bool Expanded { get; set; }

Property Value

Gets or sets the ribbon help button element.

Declaration

public RadImageButtonElement HelpButton { get; set; }

Property Value

Gets the icon primitive element used to display the application icon.

Declaration

public ImagePrimitive IconPrimitive { get; }

Property Value

Gets or sets the ribbon layout.

Declaration

[Browsable(true)]
public RibbonLayout LayoutMode { get; set; }

Property Value

Gets or sets the ribbon layout mode button element.

Declaration

public RadToggleSwitchElement LayoutModeButton { get; set; }

Property Value

Gets or sets the ribbon layout mode text element.

Declaration

public LightVisualElement LayoutModeTextElement { get; set; }

Property Value

Gets or sets the localization settings for this ribbon bar element.

Declaration

public RibbonBarLocalizationSettings LocalizationSettings { get; }

Property Value

Gets or sets the MDI controls item for handling MDI window operations.

Declaration

public RadMDIControlsItem MDIbutton { get; }

Property Value

Gets or sets a value indicating whether the maximize button is visible in the ribbon caption.

Declaration

public bool MaximizeButton { get; set; }

Property Value

Gets or sets a value indicating whether the minimize button is visible in the ribbon caption.

Declaration

public bool MinimizeButton { get; set; }

Property Value

Gets the options menu button

Declaration

[Browsable(false)]
public RadMenuButtonItem OptionsButton { get; }

Property Value

Gets an instance of the RibbonBarPopup class which represents the ribbon bar popup.

Declaration

[Browsable(false)]
public RibbonBarPopup Popup { get; }

Property Value

Gets or sets the height of the quick access.

Declaration

[Browsable(true)]
public int QuickAccessMenuHeight { get; set; }

Property Value

Gets the collection of quick access toolbar items.

Declaration

[Browsable(true)]
public RadItemOwnerCollection QuickAccessMenuItems { get; }

Property Value

Gets the Quick Access Toolbar element.

Declaration

[Browsable(false)]
public RadQuickAccessToolBar QuickAccessToolBar { get; }

Property Value

Gets or sets if the quick access toolbar is below the ribbon.

Declaration

[Browsable(true)]
public bool QuickAccessToolbarBelowRibbon { get; set; }

Property Value

Gets or sets the ribbon caption element.

Declaration

public RadRibbonBarCaption RibbonCaption { get; set; }

Property Value

Gets the instance of the currently selected command tab.

Declaration

[Browsable(false)]
public RibbonTab SelectedCommandTab { get; }

Property Value

Gets or sets a value indicating whether the expand button is visible or hidden.

Declaration

public bool ShowExpandButton { get; set; }

Property Value

Gets a value indicating whether the help button is visible or hidden.

Declaration

public bool ShowHelpButton { get; set; }

Property Value

Gets or sets whether the toggle switch enabling the Simplified ribbon style is visible.

Declaration

[Browsable(true)]
public bool ShowLayoutModeButton { get; set; }

Property Value

Gets or sets the height of the simplified ribbon.

Declaration

[Browsable(true)]
public int SimplifiedHeight { get; set; }

Property Value

Gets or sets the image of the start button placed in the top left corner.

Declaration

[TypeConverter(typeof(ImageTypeConverter))]
[Browsable(true)]
public Image StartButtonImage { get; set; }

Property Value

Gets the collection of start button menu items which appear at the bottom when the button has two columns.

Declaration

[Browsable(true)]
public RadItemOwnerCollection StartMenuBottomStrip { get; }

Property Value

Gets the collection of start button menu items.

Declaration

[Browsable(true)]
public RadItemOwnerCollection StartMenuItems { get; }

Property Value

Gets the collection of start button menu items which appear on the right column.

Declaration

[Browsable(true)]
public RadItemOwnerCollection StartMenuRightColumnItems { get; }

Property Value

Gets or sets the width of the start menu

Declaration

[Browsable(true)]
public int StartMenuWidth { get; set; }

Property Value

Gets an instance of the RibbonTabStripElement which displays the tab items in the ribbon bar.

Declaration

[Browsable(false)]
public RibbonTabStripElement TabStripElement { get; }

Property Value

Arranges the child elements of the ribbon bar within the specified size.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

Changes the base fill style for the tab based on the contextual group.

Declaration

protected virtual void ChangeTabBaseFillStyle(ContextualTabGroup group, LightVisualElement contentArea, LightVisualElement tabFill)

Parameters

Handles the control's visible changed event.

Declaration

protected void Control_VisibleChanged(object sender, EventArgs e)

Parameters

Creates the child elements of the ribbon bar.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates a new RibbonBarPopup instance.

Declaration

protected virtual RibbonBarPopup CreateRibbonPopup()

Returns

Releases managed resources used by the element.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Performs the core expand/collapse logic for the ribbon bar.

Declaration

protected virtual void DoExpandCollapse()

Handles DPI scale changes for the ribbon bar element.

Declaration

public override void DpiScaleChanged(SizeF scaleFactor)

Parameters

Overrides RadElement.DpiScaleChanged(SizeF)

Gets the maximum margin from ribbon groups in the specified holder.

Declaration

protected virtual float GetMaximumRibbonGroupMargin(ExpandableStackLayout groupsHolder)

Parameters

Returns

Gets the maximum height of tab content across all command tabs.

Declaration

protected virtual float GetMaximumTabContentHeight()

Returns

Gets the maximum height of the tab strip including content.

Declaration

protected virtual float GetMaximumTabStripHeight()

Returns

Initializes the fields used by the ribbon bar element.

Declaration

protected override void InitializeFields()

Overrides LightVisualElement.InitializeFields()

Measures the ribbon bar element and returns the desired size.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides LightVisualElement.MeasureOverride(SizeF)

Raises the ApplicationMenuStyleChanged event.

Declaration

protected virtual void OnApplicationMenuStyleChanged(EventArgs args)

Parameters

Handles bubble events from child elements.

Declaration

protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)

Parameters

Overrides RadElement.OnBubbleEvent(RadElement, RoutedEventArgs)

Raises the CommandTabCollapsed event.

Declaration

protected virtual void OnCommandTabCollapsed(CommandTabEventArgs args)

Parameters

Raises the CommandTabExpanded event.

Declaration

protected virtual void OnCommandTabExpanded(CommandTabEventArgs args)

Parameters

Raises the CommandTabSelected event.

Declaration

protected virtual void OnCommandTabSelected(CommandTabEventArgs args)

Parameters

Raises the CommandTabSelecting event.

Declaration

protected virtual void OnCommandTabSelecting(CommandTabSelectingEventArgs args)

Parameters

Raises the ItemStyleChanged event.

Declaration

protected virtual void OnItemStyleChanged(object sender, ItemStyleChangedEventArgs args)

Parameters

Raises the ItemStyleChanging event.

Declaration

protected virtual void OnItemStyleChanging(object sender, ItemStyleChangingEventArgs args)

Parameters

Raises the ItemVisiblityStateChanging event.

Declaration

protected virtual void OnItemVisiblityStateChanging(object sender, ItemVisiblityStateChangingEventArgs args)

Parameters

Raises the LayoutModeChanged event.

Declaration

protected virtual void OnLayoutModeChanged(EventArgs args)

Parameters

Called when the element is loaded into the element tree.

Declaration

protected override void OnLoaded()

Overrides LightVisualElement.OnLoaded()

Handles property changes for the ribbon bar element.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides LightVisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the ExpandedStateChanged event.

Declaration

protected virtual void OnRibbonBarExpandedStateChanged(EventArgs args)

Parameters

Called when the show ribbon layout button property changes.

Declaration

protected virtual void OnShowRibbonLayoutButtonChanged()

Called when the simplified ribbon height property changes.

Declaration

protected virtual void OnSimplifiedRibbonHeightChanged()

Paints the ribbon bar element.

Declaration

protected override void PaintOverride(IGraphics screenRadGraphics, Rectangle clipRectangle, float angle, SizeF scale, bool useRelativeTransformation)

Parameters

Overrides RadItem.PaintOverride(IGraphics, Rectangle, float, SizeF, bool)

Performs the core logic for expanding or collapsing the ribbon bar.

Declaration

protected virtual void PerformExpandedCore()

Shows a popup for the specified page view item.

Declaration

public void ShowPopup(RadPageViewItem item)

Parameters

Updates references when the element tree changes.

Declaration

protected override void UpdateReferences(ComponentThemableElementTree tree, bool updateInheritance, bool recursive)

Parameters

Overrides RadElement.UpdateReferences(ComponentThemableElementTree, bool, bool)

Occurs when the application menu style is changed.

Declaration

public event EventHandler ApplicationMenuStyleChanged

Event Value

Occurs when a command tab is collapsed by double clicking an expanded command tab item.

Declaration

public event CommandTabEventHandler CommandTabCollapsed

Event Value

Occurs when a command tab is expanded by double clicking a collapsed command tab item.

Declaration

public event CommandTabEventHandler CommandTabExpanded

Event Value

Occurs when a command tab is selected.

Declaration

public event CommandTabEventHandler CommandTabSelected

Event Value

Occurs just before a command tab is selected.

Declaration

public event CommandTabSelectingEventHandler CommandTabSelecting

Event Value

Occurs when the ribbon bar is either expanded or collapsed.

Declaration

public event EventHandler ExpandedStateChanged

Event Value

Occurs after a RadProperty has changed after changing the layout mode.

Declaration

public event ItemStyleChangedEventHandler ItemStyleChanged

Event Value

Occurs when a RadProperty is about to be changed after changing the layout mode.

Declaration

public event ItemStyleChangingEventHandler ItemStyleChanging

Event Value

Occurs when an item's visibility state is about to be changed while resizing the ribbon bar.

Declaration

public event ItemVisiblityStateChangingEventHandler ItemVisiblityStateChanging

Event Value

Occurs when the layout mode is changed between Default and Simplified.

Declaration

public event EventHandler LayoutModeChanged

Event Value