Documentation

Class RadRibbonBarElement

Represents a ribbon bar element. The RadRibbonBarElement can be nested in other telerik controls. Essentially RadRibbonBar class is a simple wrapper for RadRibbonBarElement class. RadRibbonBar acts to transfer events to and from the its corresponding instance of the RadRibbonBarElement.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadRibbonBarElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[ComVisible(false)]
public class RadRibbonBarElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadRibbonBarElement()

Declaration
public RadRibbonBarElement()

Fields

IsBackstageModeProperty

Declaration
public static RadProperty IsBackstageModeProperty
Field Value
RadProperty

IsRibbonFormActiveProperty

Declaration
public static RadProperty IsRibbonFormActiveProperty
Field Value
RadProperty

QuickAccessMenuHeightProperty

Declaration
public static RadProperty QuickAccessMenuHeightProperty
Field Value
RadProperty

QuickAccessToolbarBelowRibbonProperty

Declaration
public static RadProperty QuickAccessToolbarBelowRibbonProperty
Field Value
RadProperty

RibbonFormWindowStateProperty

Declaration
public static RadProperty RibbonFormWindowStateProperty
Field Value
RadProperty

SimplifiedHeightProperty

Declaration
public static RadProperty SimplifiedHeightProperty
Field Value
RadProperty

Properties

ApplicationButtonElement

Gets the application menu element

Declaration
public RadApplicationMenuButtonElement ApplicationButtonElement { get; }
Property Value
RadApplicationMenuButtonElement

ApplicationMenuRightColumnWidth

Declaration
public int ApplicationMenuRightColumnWidth { get; set; }
Property Value
System.Int32

ApplicationMenuStyle

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

BackstageControl

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

ButtonsContainer

Declaration
public StackLayoutElement ButtonsContainer { get; }
Property Value
StackLayoutElement

CaptionBorder

Gets the BorderPrimitiveinstance that represents the border of the ribbon's caption.

Declaration
public BorderPrimitive CaptionBorder { get; }
Property Value
BorderPrimitive

CaptionFill

Gets the FillPrimitiveinstance that represents the fill of the ribbon's caption.

Declaration
public FillPrimitive CaptionFill { get; }
Property Value
FillPrimitive

CloseButton

Gets or sets the Close button

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

CollapseRibbonOnTabDoubleClick

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

CollapsingEnabled

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

CommandTabs

Gets a collection of the command tabs.

Declaration
[RadEditItemsAction]
public RadRibbonBarCommandTabCollection CommandTabs { get; }
Property Value
RadRibbonBarCommandTabCollection

ContextualTabGroups

Gets a collection of contextual tab groups.

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

ExitButton

Gets the exit menu button

Declaration
public RadMenuButtonItem ExitButton { get; }
Property Value
RadMenuButtonItem

ExpandButton

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

Expanded

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

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

HelpButton

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

IconPrimitive

Declaration
public ImagePrimitive IconPrimitive { get; }
Property Value
ImagePrimitive

LayoutMode

Gets or sets the ribbon layout.

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

LayoutModeButton

Declaration
public RadToggleSwitchElement LayoutModeButton { get; set; }
Property Value
RadToggleSwitchElement

LayoutModeTextElement

Declaration
public LightVisualElement LayoutModeTextElement { get; set; }
Property Value
LightVisualElement

LocalizationSettings

Gets or the localization settings for this element

Declaration
public RibbonBarLocalizationSettings LocalizationSettings { get; }
Property Value
RibbonBarLocalizationSettings

MaximizeButton

Gets or sets the Maximize button

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

MDIbutton

Declaration
public RadMDIControlsItem MDIbutton { get; }
Property Value
RadMDIControlsItem

MinimizeButton

Gets or sets the Minimize button

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

OptionsButton

Gets the options menu button

Declaration
public RadMenuButtonItem OptionsButton { get; }
Property Value
RadMenuButtonItem

Popup

Gets an instance of the RibbonBarPopup class which represents the RadRibbonBar popup.

Declaration
public RibbonBarPopup Popup { get; }
Property Value
RibbonBarPopup

QuickAccessMenuHeight

Gets or sets the height of the quick access.

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

QuickAccessMenuItems

Gets the collection of quick access menu items.

Declaration
public RadItemOwnerCollection QuickAccessMenuItems { get; }
Property Value
RadItemOwnerCollection

QuickAccessToolBar

Gets the QuickAccessToolBar

Declaration
public RadQuickAccessToolBar QuickAccessToolBar { get; }
Property Value
RadQuickAccessToolBar

QuickAccessToolbarBelowRibbon

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

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

RibbonCaption

Declaration
public RadRibbonBarCaption RibbonCaption { get; set; }
Property Value
RadRibbonBarCaption

SelectedCommandTab

Gets the instance of the currently selected command tab.

Declaration
public RibbonTab SelectedCommandTab { get; }
Property Value
RibbonTab

ShowExpandButton

Get or sets value indicating whether RibbonBar Expand 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

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

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

SimplifiedHeight

Gets or sets the height of the simplified ribbon.

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

StartButtonImage

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

Declaration
public Image StartButtonImage { get; set; }
Property Value
System.Drawing.Image

StartMenuBottomStrip

Gets the collection of the start button menu DropDown which is displayed when the button has two columns.

Declaration
public RadItemOwnerCollection StartMenuBottomStrip { get; }
Property Value
RadItemOwnerCollection

StartMenuItems

Gets the collection of the start button menu item.

Declaration
public RadItemOwnerCollection StartMenuItems { get; }
Property Value
RadItemOwnerCollection

StartMenuRightColumnItems

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

Declaration
public RadItemOwnerCollection StartMenuRightColumnItems { get; }
Property Value
RadItemOwnerCollection

StartMenuWidth

Gets or sets the width of the start menu

Declaration
public int StartMenuWidth { get; set; }
Property Value
System.Int32

TabStripElement

Gets an instance of the TabStripElement which is used to display the tab items in the RibbonBarElement.

Declaration
public RibbonTabStripElement TabStripElement { get; }
Property Value
RibbonTabStripElement

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

ChangeTabBaseFillStyle(ContextualTabGroup, LightVisualElement, LightVisualElement)

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

LightVisualElement contentArea

LightVisualElement tabFill

Control_VisibleChanged(Object, EventArgs)

Declaration
protected void Control_VisibleChanged(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateRibbonPopup()

Creates a new RibbonBarPopup.

Declaration
protected virtual RibbonBarPopup CreateRibbonPopup()
Returns
RibbonBarPopup

The created pop-up.

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

DoExpandCollapse()

Declaration
protected virtual void DoExpandCollapse()

DpiScaleChanged(SizeF)

Declaration
public override void DpiScaleChanged(SizeF scaleFactor)
Parameters
System.Drawing.SizeF scaleFactor

Overrides

GetMaximumRibbonGroupMargin(ExpandableStackLayout)

Declaration
protected virtual float GetMaximumRibbonGroupMargin(ExpandableStackLayout groupsHolder)
Parameters
ExpandableStackLayout groupsHolder

Returns
System.Single

GetMaximumTabContentHeight()

Declaration
protected virtual float GetMaximumTabContentHeight()
Returns
System.Single

GetMaximumTabStripHeight()

Declaration
protected virtual float GetMaximumTabStripHeight()
Returns
System.Single

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

OnApplicationMenuStyleChanged(EventArgs)

Raises the ApplicationMenuStyleChanged event.

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

An CommandTabEventArgs that contains the event data.

OnBubbleEvent(RadElement, RoutedEventArgs)

Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

RoutedEventArgs args

Overrides

OnCommandTabCollapsed(CommandTabEventArgs)

Raises the CommandTabCollapsed event.

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

An CommandTabEventArgs that contains the event data.

OnCommandTabExpanded(CommandTabEventArgs)

Raises the CommandTabExpanded event.

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

An CommandTabEventArgs that contains the event data.

OnCommandTabSelected(CommandTabEventArgs)

Raises the CommandTabSelected event.

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

An CommandTabEventArgs that contains the event data.

OnCommandTabSelecting(CommandTabSelectingEventArgs)

Raises the CommandTabSelecting event.

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

An CommandTabSelectingEventArgs that contains the event data.

OnItemStyleChanged(Object, ItemStyleChangedEventArgs)

Raises the ItemStyleChanged event.

Declaration
protected virtual void OnItemStyleChanged(object sender, ItemStyleChangedEventArgs args)
Parameters
System.Object sender

The group where the item is located.
ItemStyleChangedEventArgs args

An ItemStyleChangedEventArgs that contains the event data.

OnItemStyleChanging(Object, ItemStyleChangingEventArgs)

Raises the ItemStyleChanging event.

Declaration
protected virtual void OnItemStyleChanging(object sender, ItemStyleChangingEventArgs args)
Parameters
System.Object sender

The group where the item is located.
ItemStyleChangingEventArgs args

An ItemStyleChangingEventArgs that contains the event data.

OnItemVisiblityStateChanging(Object, ItemVisiblityStateChangingEventArgs)

Raises the ItemVisiblityStateChanging event.

Declaration
protected virtual void OnItemVisiblityStateChanging(object sender, ItemVisiblityStateChangingEventArgs args)
Parameters
System.Object sender

The item which is about to be changed.
ItemVisiblityStateChangingEventArgs args

An ItemVisiblityStateChangingEventArgs that contains the event data.

OnLayoutModeChanged(EventArgs)

Raises the LayoutModeChanged event.

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

An System.EventArgs that contains the event data.

OnLoaded()

Declaration
protected override void OnLoaded()
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnRibbonBarExpandedStateChanged(EventArgs)

Raises the ExpandedStateChanged event.

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

An System.EventArgs instance that contains the event data.

OnShowRibbonLayoutButtonChanged()

Declaration
protected virtual void OnShowRibbonLayoutButtonChanged()

OnSimplifiedRibbonHeightChanged()

Declaration
protected virtual void OnSimplifiedRibbonHeightChanged()

PaintOverride(IGraphics, Rectangle, Single, SizeF, Boolean)

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

System.Drawing.Rectangle clipRectangle

System.Single angle

System.Drawing.SizeF scale

System.Boolean useRelativeTransformation

Overrides

PerformExpandedCore()

Declaration
protected virtual void PerformExpandedCore()

ShowPopup(RadPageViewItem)

Declaration
public void ShowPopup(RadPageViewItem item)
Parameters
RadPageViewItem item

UpdateReferences(ComponentThemableElementTree, Boolean, Boolean)

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

System.Boolean updateInheritance

System.Boolean recursive

Overrides

Events

ApplicationMenuStyleChanged

Declaration
public event EventHandler ApplicationMenuStyleChanged
Event Type
System.EventHandler

CommandTabCollapsed

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

Declaration
public event CommandTabEventHandler CommandTabCollapsed
Event Type
CommandTabEventHandler

CommandTabExpanded

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

Declaration
public event CommandTabEventHandler CommandTabExpanded
Event Type
CommandTabEventHandler

CommandTabSelected

Occurs when a command tab is selected.

Declaration
public event CommandTabEventHandler CommandTabSelected
Event Type
CommandTabEventHandler

CommandTabSelecting

Occurs just before a command tab is selected.

Declaration
public event CommandTabSelectingEventHandler CommandTabSelecting
Event Type
CommandTabSelectingEventHandler

ExpandedStateChanged

Declaration
public event EventHandler ExpandedStateChanged
Event Type
System.EventHandler

ItemStyleChanged

Occurs after a RadProperty has changed after changing the RibbonLayout.

Declaration
public event ItemStyleChangedEventHandler ItemStyleChanged
Event Type
ItemStyleChangedEventHandler

ItemStyleChanging

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

Declaration
public event ItemStyleChangingEventHandler ItemStyleChanging
Event Type
ItemStyleChangingEventHandler

ItemVisiblityStateChanging

Occurs when an item`s visibility state is about to be changed. The event is raised while resizing the RibbonBar.

Declaration
public event ItemVisiblityStateChangingEventHandler ItemVisiblityStateChanging
Event Type
ItemVisiblityStateChangingEventHandler

LayoutModeChanged

Declaration
public event EventHandler LayoutModeChanged
Event Type
System.EventHandler

Extension Methods