Back to Devexpress

RibbonControl Properties

windowsforms-devexpress-dot-xtrabars-dot-ribbon-dot-ribboncontrol-dot-underscore-properties.md

latest63.1 KB
Original Source

RibbonControl Properties

Allows you to create a Ribbon toolbar with commands grouped into categories, pages and page groups.

NameDescription
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRibbonGets the object that provides the accessibility information.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
AllowContentChangeAnimationGets or sets whether to use animation when changing pages.
AllowCustomizationGets or sets whether an end-user can customize the current RibbonControl at runtime.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowGlyphSkinningGets or sets whether glyphs for all BarItems within the RibbonControl should be painted using the text foreground color.
AllowHtmlTextGets or sets whether a BarItemLinks’ text within the current RibbonControl can be formatted using HTML tags.
AllowInplaceLinksFor internal use.
AllowKeyTipsGets or sets whether Key Tips are enabled.
AllowMdiChildButtonsGets or sets whether MDI buttons for the current RibbonControl‘s child Ribbons are enabled.
AllowMergeInvisibleItems staticGets or sets whether invisible items within a parent RibbonControl should be merged with child RibbonControl‘s items with same captions.
AllowMinimizeRibbonGets or sets whether the Ribbon can be minimized. If this property is set to false, the ribbon context menu does not show the Minimize the Ribbon command, the Minimized property is not in effect, and the Ribbon cannot be minimized on a double click.
AllowMinimizeRibbonOnDoubleClickGets or sets whether the user can minimize the Ribbon by double-clicking a page header.
AllowTrimPageTextGets or sets whether text in Ribbon page tabs (RibbonPage.Text) is trimmed when reducing the Ribbon Control’s width.
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
ApplicationButtonAccessibleDescriptionGets or sets the description for the Application Button used by client accessibility applications.
ApplicationButtonAccessibleNameGets or sets the name for the Application Button which is used by client accessibility applications.
ApplicationButtonAnimationLengthGets or sets the length of the fading animation effect for the Application Button.
ApplicationButtonDropDownControlGets or sets the drop-down control which is invoked when the Application Button is clicked.
ApplicationButtonImageOptionsProvides access to options that allow you to specify and customize the Application Button‘s raster or vector icon.
ApplicationButtonKeyTipGets or sets the Key Tip for the Application Button.
ApplicationButtonSuperTipGets or sets a SuperToolTip for the Application Button.
ApplicationButtonTextGets or sets the Application Button‘s text.
ApplicationCaptionGets or sets the second portion of the RibbonForm’s caption which generally specifies the name of the current application.
ApplicationDocumentCaptionGets or sets the first portion of the RibbonForm’s caption which generally specifies the name of the active document.
ApplicationIconGets or sets an image displayed in the Application Button.
AutoHiddenPagesMenuItemFor internal use.
AutoHideEmptyItemsGets or sets whether all empty items within this RibbonControl should be automatically hidden.
AutoSaveLayoutToXmlGets or sets whether the RibbonControl automatically saves its layout when the parent form is closed.
AutoSaveLayoutToXmlPathGets or sets the path to the XML file where the layout is automatically saved.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSizeThis property is not supported by the RibbonControl class.
AutoSizeItemsGets or sets whether bar item links are displayed with the same width within a group.
AutoUpdateMergedRibbonsGets or sets whether items added to/removed from a child ribbon merged with this ribbon are automatically added to/removed from this ribbon.
BackColorGets or sets the background color for the control. Inherited from Control.
BackgroundImageThis member supports the internal infrastructure, and is not intended to be used directly from your code.
BackgroundImageLayoutThis member supports the internal infrastructure, and is not intended to be used directly from your code.
BindingContextGets or sets the BindingContext for the control. Inherited from Control.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
ButtonGroupsLayoutGets or sets the button group layout for all BarButtonGroup objects within this RibbonControl.
ButtonGroupsVertAlignGets or sets the vertical alignment of button groups within Ribbon page groups.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CaptionBarItemLinksProvides access to bar item links displayed in the RibbonForm‘s caption area.
CaptionBarMinWidthGets or sets the minimum width (in pixels) for the Ribbon caption bar.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CategoriesGets a collection of categories used to logically organize bar items.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
ColorSchemeGets or sets the color applied to specific RibbonControl elements.
CommandLayoutGets or sets the RibbonControl‘s command layout: single-row Simplified or default Classic.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenuOverrides the ContextMenu property.
ControllerGets or sets the bar and dock controller that specifies default appearance settings for the Ribbon Control.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CreateParams protectedGets the required creation parameters when the control handle is created. Inherited from Control.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the ControlBase control. Inherited from ControlBase.
DataBindingsGets the data bindings for the control. Inherited from Control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protectedGets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DefaultPageCategoryProvides access to pages associated with the default page category.
DefaultSize protectedGets the default size of the control. Inherited from Control.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisableAccessibility staticGets or sets whether the Ribbon Control’s accessibility feature (providing information on the control’s data to accessibility tools, e.g., MS Narrator) is disabled. This is a static property, and thus it affects all Ribbon Controls in your application.
DisplayRectangleGets the rectangle that represents the display area of the control. Inherited from Control.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DockThis member overrides the Dock property.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
DrawGroupCaptionsGets or sets whether to draw captions for Ribbon Page Groups.
DrawGroupsBorderObsolete. Gets or sets whether to draw borders for Ribbon Page Groups.
DrawGroupsBorderModeGets or sets whether or not Ribbon page groups should display their borders and captions.
EmptyAreaImageOptionsProvides access to options that specify a raster or vector image displayed in the ribbon’s empty area.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpandCollapseItemProvides access to the predefined button that expands/colapses the ribbon.
ExternalRepositoryGets or sets the external editors repository.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FontGets or sets the control font. Inherited from ControlBase.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the foreground color of the control. Inherited from Control.
FullScreenGets or sets whether the RibbonControl is displayed in the auto-hidden mode, while the RibbonForm is maximized up to the full screen. This property is in effect for the RibbonControl embedded into the RibbonForm, and displayed using the Office2013 style.
GalleryAnimationLengthGets or sets the length of the fading animation effect for gallery items.
GroupAnimationLengthGets or sets the length of the fading animation effect for Ribbon page groups.
HandleGets the window handle that the control is bound to. Inherited from Control.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HeaderAreaImageOptionsAllows you to access settings that control the header area image.
HeightGets or sets the height of the control. Inherited from Control.
HtmlImagesGets or sets a collection of images that can be inserted into item captions using the image tag.
ImageGets or sets the custom background image for this RibbonControl.
ImageAlignmentGets or sets the alignment of a background Ribbon image.
ImagesGets or sets the source of images that can be displayed within item links.
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsDesignModeGets a value which indicates whether the Ribbon Control is currently in design mode.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
IsRightToLeftGets whether the ControlBase‘s visual elements are actually aligned to support locales using right-to-left fonts. Inherited from ControlBase.
ItemAnimationLengthGets or sets the length of the fading animation effect for the RibbonControl’s bar item links.
ItemPanelStyleGets or sets whether the panel for RibbonControl items occupies the entire form width (the Classic style), or is drawn according to the current application Skin.
ItemsProvides access to a Ribbon Control’s item collection.
ItemsVertAlignGets or sets the vertical alignment of bar items within Ribbon page groups.
KeyTipManagerGets the key tip manager.
LargeImagesGets or sets the source of large images that can be displayed within item links.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LayoutVersionGets or sets the version of the Ribbon layout. You should assign versions to layouts, if you need to customize the Ribbon layout after a previous layout version has been loaded from a data store (a stream, xml file or system registry) and applied to the control.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
ManagerGets the Ribbon BarManager.
MarginGets or sets the space between controls. Inherited from Control.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MaxItemIdThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
MdiMergeStyleGets or sets if and when a merge mechanism is invoked in an MDI application.
MergedCategoriesProvides access to categories that have been merged into the Ribbon Control.
MergedMessagesGets a collection of messages from merged child ribbons. The Ribbon control displays these messages in the message bar.
MergedPagesProvides access to pages that have been merged into the default category of the Ribbon Control.
MergedRibbonGets the RibbonControl that has been merged into the current RibbonControl object.
MergeOwnerThis member supports the internal infrastructure, and is not intended to be used directly from your code.
MessagesGets a collection of messages displayed in the message bar.
MinimizedGets or sets whether the ribbon is minimized.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
MiniToolbarsProvides access to the collection of RibbonMiniToolbar objects.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MoreCommandsItemFor internal use.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
NameGets or sets the name of the control. Inherited from Control.
NotifyAccessibilityClientsThis member supports the internal infrastructure, and is not intended to be used directly from your code.
OptionsAnimationProvides access to animation settings for this RibbonControl.
OptionsCustomizationFormProvides access to the Customization Form‘s settings.
OptionsExpandCollapseMenuGets the availability and behavior settings of the Ribbon Display Options popup menu.
OptionsMenuMinWidthGets or sets the minimum width of the Display Options button’s dropdown window.
OptionsPageCategoriesProvides access to category settings. Categories are stored in the RibbonControl.Categories collection.
OptionsSearchMenu
OptionsStubGlyphsProvides access to options that modify a stub glyphs’ appearance.
OptionsTouchProvides access to properties that specify this RibbonControl‘s behavior on touch-input devices.
PaddingThis member is not supported by the RibbonControl.
PageAnimationLengthGets or sets the length of the fading animation effect for the RibbonControl’s page headers.
PageCategoriesGets the collection of custom page categories, which allows contextual tab pages to be added and manipulated.
PageCategoryAlignmentGets or sets the alignment of custom page categories, which display contextual tab pages.
PageHeaderItemLinksGets a collection of bar item links displayed at the right edge of the control in the same row with tab headers.
PageHeaderMinWidthGets or sets the minimum allowed width of page headers.
PagesProvides access to the Ribbon Control’s main pages.
ParentGets or sets the parent container of the control. Inherited from Control.
PopupMenuAlignmentGets or sets how popup menus associated with this RibbonControl should be aligned.
PopupShowModeGets or sets whether nested popup sub-menus are displayed in cascaded or inplace mode.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
QuickToolbarItemLinksGets the collection of item links displayed in the Quick Access Toolbar.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
ReduceOperationsThis member supports the internal infrastructure, and is not intended to be used directly from your code.
RegionGets or sets the window region associated with the control. Inherited from Control.
RegistrationInfoGets the registration info for this RibbonControl.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
RepositoryItemsProvides access to the control’s internal repository.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RibbonCaptionAlignmentGets or sets the alignment of the ribbon caption in a Ribbon Form.
RibbonStyleGets or sets the style of the RibbonControl.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftGets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
RowCountFor internal use.
ScaleChildren protectedGets a value that determines the scaling of child controls. Inherited from Control.
SearchEditItemProvides access to the bar item that represents the search box. For internal use.
SearchItemPositionGets or sets the position of the Search box.
SearchItemShortcutGets or sets the shortcut used to focus the search box.
SearchRepositoryItemProvides access to the repository item that represents the search box. For internal use.
SelectedPageGets or sets the currently selected page.
ShowApplicationButtonGets or sets whether the Application Button is visible.
ShowCategoryInCaptionGets or sets whether category names are displayed in the RibbonForm’s title bar.
ShowDisplayOptionsMenuButtonGets or sets whether the button allowing an end-user to switch between the regular, minimized and full-screen ribbon modes is displayed in the form title bar. This property is in effect for the RibbonControl embedded into the RibbonForm, and displayed using the Office2013 style.
ShowExpandCollapseButtonGets or sets whether the Ribbon Control displays a button that allows an end-user to hide/restore the RibbonControl’s pages.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowFullScreenButtonGets or sets whether the button allowing an end-user to switch between the regular, minimized and full-screen ribbon modes is displayed in the form title bar. This property is in effect for the RibbonControl embedded into the RibbonForm, and displayed using the Office2013 style.
ShowItemCaptionsInCaptionBarSpecifies whether or not bar item links from the RibbonControl.CaptionBarItemLinks collection should display their captions.
ShowItemCaptionsInPageHeaderGets or sets whether item links within page header area should display their captions.
ShowItemCaptionsInQATGets or sets whether bar item links within the Quick Access Toolbar should display their captions.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
ShowMoreCommandsButtonGets or sets whether to show the button that invokes a drop-down list of commands that are not visible in the ribbon due to insufficient space.
ShowPageHeadersObsolete. Gets or sets whether page headers are displayed.
ShowPageHeadersInFormCaptionGets or sets whether ribbon page headers are displayed in place of the regular form title bar. This property is in effect for the RibbonControl displayed using the OfficeUniversal style, and embedded into the RibbonForm.
ShowPageHeadersModeGets or sets page headers display mode.
ShowPageKeyTipsModeGets or sets whether to display key tips for ribbon pages.
ShowQatLocationSelectorGets or sets whether the option that allows an end-user to change the Quick Access Toolbar location is displayed in the customization menus.
ShowSearchItemUse the RibbonOptionsSearchMenu.SearchItemPosition property to control search item visibility.
ShowToolbarCustomizeItemGets or sets whether the customize item is displayed within the Quick Access Toolbar.
SingleTapToShowKeyboardGets or sets whether users should tap editors once or twice to display the on-screen keyboard (when the application runs on touch-screen devices).
SiteGets or sets the site of the control. Inherited from Control.
SizeGets or sets the height and width of the control. Inherited from Control.
StatusBarGets or sets the RibbonStatusBar object linked with the current Ribbon Control.
TabIndexThis member overrides the TabIndex property.
TabStopThis member overrides the TabStop property.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextThis member overrides the Text property.
ToolbarProvides access to the Quick Access Toolbar.
ToolbarLocationGets or sets the position of the Quick Access Toolbar.
ToolTipControllerGets or sets the tooltip controller component that controls the appearance, position and content of tooltips displayed by elements of the RibbonControl.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
TotalPageCategoryAllows you to return all pages and visible pages owned by the RibbonControl.
TransparentEditorsThis property is provided for backward compatibility. Use the RibbonControl.TransparentEditorsMode property instead.
TransparentEditorsModeGets or sets whether specific in-place editors, when focused, are painted using a transparent background color.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
ViewInfoGets the Ribbon Control’s view information.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.

See Also

RibbonControl Class

RibbonControl Members

DevExpress.XtraBars.Ribbon Namespace