Class RadRibbonBar

other Telerik RadControls and Windows Represents a RadRibbonBar. The RadRibbon bar visual appearance can be customized in numerous ways through themes. Also you can nest other telerik controls in the ribbon bar chunks thus creating intuitive interface for your applications. All of the application's functionality is accessible from a single ribbon. The ribbon is divided into command tabs such as Write, Insert, and Page Layout. When the users clicks on a command tab, they see chunks such as Clipboard, Font, and Paragraph. Each chunk can hold an unlimited number of controls including toolbars, comboboxes, and Forms controls.

The RadRibbonBar class is a simple wrapper for the RadRibbonBarElement class. All UI and logic functionality is implemented in RadRibbonBarElement class. RadRibbonBar acts to transfer the events to and from its RadRibbonBarElement class.

Inheritance
System.Object
RadControl
RadNonClientUIControl
RadRibbonBar
RadDiagramRibbonBar
RadSpreadsheetRibbonBar
RichTextEditorRibbonBar
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Menus & Toolbars")]
public class RadRibbonBar : RadNonClientUIControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadRibbonBar()

Declaration
public RadRibbonBar()

Fields

ExpandCollapseCommand

Declaration
public static readonly ExpandCollapseCommand ExpandCollapseCommand
Field Value
ExpandCollapseCommand

Properties

ApplicationMenuAnimantionType

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

Declaration
public virtual FadeAnimationType ApplicationMenuAnimantionType { get; set; }
Property Value
FadeAnimationType

ApplicationMenuStyle

Declaration
public virtual ApplicationMenuStyle ApplicationMenuStyle { get; set; }
Property Value
ApplicationMenuStyle

AutoSize

Gets or sets whether the edit control is auto-sized

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BackColor

RadRibbonBar consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

BackstageControl

Declaration
public RadRibbonBarBackstageView BackstageControl { get; set; }
Property Value
RadRibbonBarBackstageView

CausesValidation

Gets or sets a flag indicating whether the control causes validation

Declaration
public bool CausesValidation { get; set; }
Property Value
System.Boolean

CloseButton

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

Declaration
public bool CloseButton { get; set; }
Property Value
System.Boolean

CollapseRibbonOnTabDoubleClick

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
System.Boolean

CommandTabs

Declaration
[RadDescription("CommandTabs", typeof(RadRibbonBarElement))]
[RadEditItemsAction]
[RadNewItem("Add New Tab...", true, true, false)]
public virtual RadRibbonBarCommandTabCollection CommandTabs { get; }
Property Value
RadRibbonBarCommandTabCollection

ContextualTabGroups

Declaration
[RadDescription("ContextualTabGroups", typeof(RadRibbonBarElement))]
[RadEditItemsAction]
[RadNewItem("Add Context...", true, true, false)]
public RadItemOwnerCollection ContextualTabGroups { get; }
Property Value
RadItemOwnerCollection

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Dock

Declaration
public override DockStyle Dock { get; set; }
Property Value
System.Windows.Forms.DockStyle

EnableKeyboardNavigation

Allows the user to navigate the control using the keyboard

Declaration
public bool EnableKeyboardNavigation { get; set; }
Property Value
System.Boolean

EnableKeyMap

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
public override bool EnableKeyMap { get; set; }
Property Value
System.Boolean

Overrides

EnableTabScrollingOnMouseWheel

Declaration
public bool EnableTabScrollingOnMouseWheel { get; set; }
Property Value
System.Boolean

ExitButton

Gets the exit menu button

Declaration
public RadMenuButtonItem ExitButton { get; }
Property Value
RadMenuButtonItem

ExpandButton

Represent the Ribbon Expand button

Declaration
public RadToggleButtonElement ExpandButton { get; set; }
Property Value
RadToggleButtonElement

Expanded

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

Declaration
public bool Expanded { get; set; }
Property Value
System.Boolean

ForeColor

RadRibbonBar consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

HelpButton

Represent the Ribbon Help button

Declaration
public RadImageButtonElement HelpButton { get; set; }
Property Value
RadImageButtonElement

HelpButtonElement

Declaration
public override RadItem HelpButtonElement { get; }
Property Value
RadItem

Overrides

IconCaptionElement

Declaration
public override ImagePrimitive IconCaptionElement { get; }
Property Value
ImagePrimitive

Overrides

LayoutMode

Declaration
[RadDescription("LayoutMode", typeof(RadRibbonBarElement))]
public RibbonLayout LayoutMode { get; set; }
Property Value
RibbonLayout

LocalizationSettings

Gets the localization settings associated with this control

Declaration
public RibbonBarLocalizationSettings LocalizationSettings { get; }
Property Value
RibbonBarLocalizationSettings

MaximizeButton

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

Declaration
public bool MaximizeButton { get; set; }
Property Value
System.Boolean

MaximizeButtonElement

Declaration
public override RadItem MaximizeButtonElement { get; }
Property Value
RadItem

Overrides

MinimizeButton

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

Declaration
public bool MinimizeButton { get; set; }
Property Value
System.Boolean

MinimizeButtonElement

Declaration
public override RadItem MinimizeButtonElement { get; }
Property Value
RadItem

Overrides

OptionsButton

Gets the options menu button

Declaration
public RadMenuButtonItem OptionsButton { get; }
Property Value
RadMenuButtonItem

QuickAccessToolBar

Gets the QuickAccessToolBar element

Declaration
public RadQuickAccessToolBar QuickAccessToolBar { get; }
Property Value
RadQuickAccessToolBar

QuickAccessToolbarBelowRibbon

Declaration
[RadDescription("QuickAccessToolbarBelowRibbon", typeof(RadRibbonBarElement))]
public bool QuickAccessToolbarBelowRibbon { get; set; }
Property Value
System.Boolean

QuickAccessToolBarHeight

Declaration
[RadDescription("QuickAccessMenuHeight", typeof(RadRibbonBarElement))]
public int QuickAccessToolBarHeight { get; set; }
Property Value
System.Int32

QuickAccessToolBarItems

Declaration
[RadEditItemsAction]
[RadDescription("QuickAccessMenuItems", typeof(RadRibbonBarElement))]
[RadNewItem("Type here", true, false)]
public virtual RadItemOwnerCollection QuickAccessToolBarItems { get; }
Property Value
RadItemOwnerCollection

RibbonBarElement

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
public RadRibbonBarElement RibbonBarElement { get; }
Property Value
RadRibbonBarElement

SelectedCommandTab

Declaration
public RibbonTab SelectedCommandTab { get; }
Property Value
RibbonTab

ShowExpandButton

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

Declaration
public bool ShowExpandButton { get; set; }
Property Value
System.Boolean

ShowHelpButton

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

Declaration
public bool ShowHelpButton { get; set; }
Property Value
System.Boolean

ShowLayoutModeButton

Declaration
[RadDescription("ShowLayoutModeButton", typeof(RadRibbonBarElement))]
public virtual bool ShowLayoutModeButton { get; set; }
Property Value
System.Boolean

SimplifiedHeight

Declaration
[RadDescription("SimplifiedHeight", typeof(RadRibbonBarElement))]
public int SimplifiedHeight { get; set; }
Property Value
System.Int32

SmallImageList

Gets or sets the small image list

Declaration
public override ImageList SmallImageList { get; set; }
Property Value
System.Windows.Forms.ImageList

Overrides

StartButtonImage

Declaration
[RadDescription("StartButtonImage", typeof(RadRibbonBarElement))]
public Image StartButtonImage { get; set; }
Property Value
System.Drawing.Image

StartMenuBottomStrip

Declaration
[RadDescription("StartMenuBottomStrip", typeof(RadRibbonBarElement))]
public RadItemOwnerCollection StartMenuBottomStrip { get; }
Property Value
RadItemOwnerCollection

StartMenuItems

Declaration
[RadEditItemsAction]
[RadDescription("StartMenuItems", typeof(RadRibbonBarElement))]
public virtual RadItemOwnerCollection StartMenuItems { get; }
Property Value
RadItemOwnerCollection

StartMenuRightColumnItems

Declaration
[RadEditItemsAction]
[RadDescription("StartMenuRightColumnItems", typeof(RadRibbonBarElement))]
public virtual RadItemOwnerCollection StartMenuRightColumnItems { get; }
Property Value
RadItemOwnerCollection

StartMenuWidth

Declaration
[RadDescription("StartMenuWidth", typeof(RadRibbonBarElement))]
[RadDefaultValue("StartMenuWidth", typeof(RadRibbonBarElement))]
public int StartMenuWidth { get; set; }
Property Value
System.Int32

SystemButtonsElement

Declaration
public override RadItem SystemButtonsElement { get; }
Property Value
RadItem

Overrides

Text

Gets or sets the text of the control

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

TextCaptionElement

Declaration
public override RadElement TextCaptionElement { get; }
Property Value
RadElement

Overrides

Methods

ControlDefinesThemeForElement(RadElement)

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

CreateBehavior()

Declaration
protected override ComponentInputBehavior CreateBehavior()
Returns
ComponentInputBehavior

Overrides

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateRibbonBarElement()

Creates a new RadRibbonBarElement.

Declaration
protected virtual RadRibbonBarElement CreateRibbonBarElement()
Returns
RadRibbonBarElement

The created ribbon bar element.

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

InitializeRootElement(RootRadElement)

Declaration
protected override void InitializeRootElement(RootRadElement rootElement)
Parameters
RootRadElement rootElement

Overrides

OnCommandTabSelected(CommandTabEventArgs)

Declaration
protected virtual void OnCommandTabSelected(CommandTabEventArgs args)
Parameters
CommandTabEventArgs args

OnCommandTabSelecting(CommandTabSelectingEventArgs)

Declaration
protected virtual void OnCommandTabSelecting(CommandTabSelectingEventArgs args)
Parameters
CommandTabSelectingEventArgs args

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnKeyTipItemActivating(RadItem, CancelEventArgs)

Declaration
protected bool OnKeyTipItemActivating(RadItem item, CancelEventArgs eventArgs)
Parameters
RadItem item

System.ComponentModel.CancelEventArgs eventArgs

Returns
System.Boolean

OnKeyTipShowing(RadItem, CancelEventArgs)

Declaration
protected virtual bool OnKeyTipShowing(RadItem currentKeyMapItem, CancelEventArgs eventArgs)
Parameters
RadItem currentKeyMapItem

System.ComponentModel.CancelEventArgs eventArgs

Returns
System.Boolean

OnLayoutModeChanged(EventArgs)

Declaration
protected virtual void OnLayoutModeChanged(EventArgs args)
Parameters
System.EventArgs args

OnMouseWheel(MouseEventArgs)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnPaint(PaintEventArgs)

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
System.Windows.Forms.PaintEventArgs e

Overrides

OnParentChanged(EventArgs)

Declaration
protected override void OnParentChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnRibbonBarExpandedStateChanged(EventArgs)

Declaration
protected virtual void OnRibbonBarExpandedStateChanged(EventArgs args)
Parameters
System.EventArgs args

OnRightToLeftChanged(EventArgs)

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnThemeChanged()

Declaration
protected override void OnThemeChanged()
Overrides

PaintKeyMap(Graphics)

Declaration
protected virtual void PaintKeyMap(Graphics graphics)
Parameters
System.Drawing.Graphics graphics

PaintKeyTip(Graphics, RadKeyTipShowingEventArgs, String)

Declaration
protected virtual void PaintKeyTip(Graphics graphics, RadKeyTipShowingEventArgs args, string keyTip)
Parameters
System.Drawing.Graphics graphics

RadKeyTipShowingEventArgs args

System.String keyTip

ProcessAutoSizeChanged(Boolean)

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

Overrides

ProcessCmdKey(ref Message, Keys)

Declaration
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters
System.Windows.Forms.Message msg

System.Windows.Forms.Keys keyData

Returns
System.Boolean

ProcessCodedUIMessage(ref IPCMessage)

Declaration
protected override void ProcessCodedUIMessage(ref IPCMessage request)
Parameters
IPCMessage request

Overrides

WmNCHitTest(ref Message)

Declaration
protected override bool WmNCHitTest(ref Message msg)
Parameters
System.Windows.Forms.Message msg

Returns
System.Boolean

Overrides

Events

CommandTabSelected

Declaration
[RadDescription("CommandTabSelected", typeof(RadRibbonBarElement))]
public event CommandTabEventHandler CommandTabSelected
Event Type
CommandTabEventHandler

CommandTabSelecting

Declaration
[RadDescription("CommandTabSelecting", typeof(RadRibbonBarElement))]
public event CommandTabSelectingEventHandler CommandTabSelecting
Event Type
CommandTabSelectingEventHandler

ExpandedStateChanged

Declaration
[RadDescription("ExpandedStateChanged", typeof(RadRibbonBarElement))]
public event EventHandler ExpandedStateChanged
Event Type
System.EventHandler

KeyTipActivating

Declaration
public event CancelEventHandler KeyTipActivating
Event Type
System.ComponentModel.CancelEventHandler

KeyTipShowing

Declaration
public event CancelEventHandler KeyTipShowing
Event Type
System.ComponentModel.CancelEventHandler

LayoutModeChanged

Declaration
[RadDescription("LayoutModeChanged", typeof(RadRibbonBarElement))]
public event EventHandler LayoutModeChanged
Event Type
System.EventHandler

Extension Methods