Class

RadRibbonBar

Initializes a new instance of the RadRibbonBar class.

Declaration

public RadRibbonBar()

Command for expanding or collapsing the ribbon bar.

Declaration

public static readonly ExpandCollapseCommand ExpandCollapseCommand

Field Value

Gets or sets a value indicating the type of the fade animation.

Declaration

public virtual FadeAnimationType ApplicationMenuAnimantionType { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public virtual ApplicationMenuStyle ApplicationMenuStyle { get; set; }

Property Value

Gets or sets the backstage control for the ribbon bar.

Declaration

[Browsable(false)]
public RadRibbonBarBackstageView BackstageControl { get; set; }

Property Value

Gets or sets a flag indicating whether the control causes validation

Declaration

[Browsable(false)]
public bool CausesValidation { get; set; }

Property Value

Gets or sets if the ribbon bar has close button in its 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

[Browsable(false)]
public bool CollapseRibbonOnTabDoubleClick { get; set; }

Property Value

Gets the collection of command tabs in the ribbon bar.

Declaration

[Browsable(true)]
[RadEditItemsAction]
[RadNewItem("Add New Tab...", true, true, false)]
public virtual RadRibbonBarCommandTabCollection CommandTabs { get; }

Property Value

Gets the collection of contextual tab groups in the ribbon bar.

Declaration

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

Property Value

Gets or sets the default size of the ribbon bar control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets which edge of the parent container a control is docked to.

Declaration

public override DockStyle Dock { get; set; }

Property Value

Overrides Control.Dock

Gets or sets whether Key Map (MS Office like accelerator keys map) is used for this specific control. Currently this option is implemented for the RadRibbonBar control only.

Declaration

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

Property Value

Overrides RadControl.EnableKeyMap

Allows the user to navigate the control using the keyboard

Declaration

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

Property Value

Gets or sets a value indicating whether tab scrolling on mouse wheel is enabled.

Declaration

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

Property Value

Gets the exit menu button

Declaration

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

Property Value

Represent the Ribbon Expand button

Declaration

public RadToggleButtonElement ExpandButton { get; set; }

Property Value

Gets or sets a value indicating whether the ribbon bar is expanded.

Declaration

[Browsable(false)]
public bool Expanded { get; set; }

Property Value

Represent the Ribbon Help button

Declaration

public RadImageButtonElement HelpButton { get; set; }

Property Value

Gets the help button element of the ribbon bar.

Declaration

public override RadItem HelpButtonElement { get; }

Property Value

Overrides RadNonClientUIControl.HelpButtonElement

Gets the icon caption element of the ribbon bar.

Declaration

public override ImagePrimitive IconCaptionElement { get; }

Property Value

Overrides RadNonClientUIControl.IconCaptionElement

Gets or sets the layout mode of the ribbon bar, determining whether it uses default or simplified layout.

Declaration

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

Property Value

Gets the localization settings associated with this control

Declaration

public RibbonBarLocalizationSettings LocalizationSettings { get; }

Property Value

Gets or sets if the ribbon bar has maximize button in its caption

Declaration

public bool MaximizeButton { get; set; }

Property Value

Gets the maximize button element of the ribbon bar.

Declaration

public override RadItem MaximizeButtonElement { get; }

Property Value

Overrides RadNonClientUIControl.MaximizeButtonElement

Gets or sets if the ribbon bar has minimize button in its caption

Declaration

public bool MinimizeButton { get; set; }

Property Value

Gets the minimize button element of the ribbon bar.

Declaration

public override RadItem MinimizeButtonElement { get; }

Property Value

Overrides RadNonClientUIControl.MinimizeButtonElement

Gets the options menu button

Declaration

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

Property Value

Gets the QuickAccessToolBar element

Declaration

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

Property Value

Gets or sets the height of the Quick Access Toolbar.

Declaration

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

Property Value

Gets the collection of items in the Quick Access Toolbar.

Declaration

[Browsable(true)]
[RadEditItemsAction]
[RadNewItem("Type here", true, false)]
public virtual RadItemOwnerCollection QuickAccessToolBarItems { get; }

Property Value

Gets or sets a value indicating whether the Quick Access Toolbar is positioned below the ribbon.

Declaration

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

Property Value

Gets the instance of RadRibbonBarElement wrapped by this control. RadRibbonBarElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadRibbonBar.

Declaration

[Browsable(false)]
public RadRibbonBarElement RibbonBarElement { get; }

Property Value

Gets the currently selected command tab in the ribbon bar.

Declaration

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

Property Value

Get or sets value indicating whether RibbonBar Help button is visible or hidden.

Declaration

public bool ShowExpandButton { get; set; }

Property Value

Get or sets value indicating whether RibbonBar Help button is visible or hidden.

Declaration

public bool ShowHelpButton { get; set; }

Property Value

Gets or sets a value indicating whether the layout mode button is visible in the ribbon bar.

Declaration

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

Property Value

Gets or sets the height of the ribbon bar when in simplified layout mode.

Declaration

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

Property Value

Gets or sets the small image list

Declaration

[Browsable(true)]
public override ImageList SmallImageList { get; set; }

Property Value

Overrides RadControl.SmallImageList

Gets or sets the image for the start button of the ribbon bar.

Declaration

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

Property Value

Gets the collection of items in the bottom strip of the start menu.

Declaration

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

Property Value

Gets the collection of items in the start menu.

Declaration

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

Property Value

Gets the collection of items in the right column of the start menu.

Declaration

[Browsable(true)]
[RadEditItemsAction]
public virtual 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 the system buttons element of the ribbon bar.

Declaration

public override RadItem SystemButtonsElement { get; }

Property Value

Overrides RadNonClientUIControl.SystemButtonsElement

Gets or sets the text of the control

Declaration

public override string Text { get; set; }

Property Value

Overrides RadControl.Text

Gets the text caption element of the ribbon bar.

Declaration

public override RadElement TextCaptionElement { get; }

Property Value

Overrides RadNonClientUIControl.TextCaptionElement

Determines whether the control defines the theme for the specified element.

Declaration

public override bool ControlDefinesThemeForElement(RadElement element)

Parameters

Returns

Overrides RadControl.ControlDefinesThemeForElement(RadElement)

Creates an accessibility instance for the ribbon bar control.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates the input behavior for handling keyboard and mouse interactions.

Declaration

protected override ComponentInputBehavior CreateBehavior()

Returns

Overrides RadControl.CreateBehavior()

Creates the child items for the ribbon bar control.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates a new RadRibbonBarElement.

Declaration

protected virtual RadRibbonBarElement CreateRibbonBarElement()

Returns

Releases the unmanaged resources used by the RadRibbonBar and optionally releases the managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides RadControl.Dispose(bool)

Initializes the root element of the ribbon bar control.

Declaration

protected override void InitializeRootElement(RootRadElement rootElement)

Parameters

Overrides RadControl.InitializeRootElement(RootRadElement)

Raises the CommandTabSelected event.

Declaration

protected virtual void OnCommandTabSelected(CommandTabEventArgs args)

Parameters

Raises the CommandTabSelecting event.

Declaration

protected virtual void OnCommandTabSelecting(CommandTabSelectingEventArgs args)

Parameters

Handles key down events for keyboard navigation and key mapping.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Handles the key tip item activation event.

Declaration

protected bool OnKeyTipItemActivating(RadItem item, CancelEventArgs eventArgs)

Parameters

Returns

Raises the KeyTipShowing event when a key tip is about to be shown.

Declaration

protected virtual bool OnKeyTipShowing(RadItem currentKeyMapItem, CancelEventArgs eventArgs)

Parameters

Returns

Raises the LayoutModeChanged event when the layout mode changes.

Declaration

protected virtual void OnLayoutModeChanged(EventArgs args)

Parameters

Handles the mouse wheel event to enable tab scrolling when configured.

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseWheel(MouseEventArgs)

Handles the paint event and renders key tips when the key map is active.

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Overrides RadControl.OnPaint(PaintEventArgs)

Handles the parent changed event to update ribbon bar text and form association.

Declaration

protected override void OnParentChanged(EventArgs e)

Parameters

Overrides RadControl.OnParentChanged(EventArgs)

Raises the ExpandedStateChanged event when the ribbon bar's expanded state changes.

Declaration

protected virtual void OnRibbonBarExpandedStateChanged(EventArgs args)

Parameters

Handles right-to-left layout changes and updates the ribbon bar accordingly.

Declaration

protected override void OnRightToLeftChanged(EventArgs e)

Parameters

Overrides RadControl.OnRightToLeftChanged(EventArgs)

Handles theme changes and updates related elements accordingly.

Declaration

protected override void OnThemeChanged()

Overrides RadControl.OnThemeChanged()

Paints the key map when keyboard navigation is active.

Declaration

protected virtual void PaintKeyMap(Graphics graphics)

Parameters

Paints an individual key tip on the specified graphics context.

Declaration

protected virtual void PaintKeyTip(Graphics graphics, RadKeyTipShowingEventArgs args, string keyTip)

Parameters

Processes auto-size changes for the ribbon bar control.

Declaration

protected override void ProcessAutoSizeChanged(bool value)

Parameters

Overrides RadControl.ProcessAutoSizeChanged(bool)

Processes command keys for keyboard navigation and arrow key handling.

Declaration

protected override bool ProcessCmdKey(ref Message msg, Keys keyData)

Parameters

Returns

Overrides Control.ProcessCmdKey(ref Message, Keys)

Processes CodedUI messages for automation support.

Declaration

protected override void ProcessCodedUIMessage(ref IPCMessage request)

Parameters

Overrides RadControl.ProcessCodedUIMessage(ref IPCMessage)

Handles window non-client hit testing for form integration.

Declaration

protected override bool WmNCHitTest(ref Message msg)

Parameters

Returns

Overrides RadNonClientUIControl.WmNCHitTest(ref Message)

Occurs when a command tab is selected.

Declaration

public event CommandTabEventHandler CommandTabSelected

Event Value

Occurs before a command tab is selected, allowing the operation to be cancelled.

Declaration

public event CommandTabSelectingEventHandler CommandTabSelecting

Event Value

Occurs when the expanded state of the ribbon bar changes.

Declaration

public event EventHandler ExpandedStateChanged

Event Value

Occurs when the user activates a key tip.

Declaration

public event CancelEventHandler KeyTipActivating

Event Value

Occurs when the ribbon bar is about to show key tips.

Declaration

public event CancelEventHandler KeyTipShowing

Event Value

Occurs when the layout mode of the ribbon bar changes.

Declaration

public event EventHandler LayoutModeChanged

Event Value