RibbonControl Properties
Allows you to create a Ribbon toolbar with commands grouped into categories, pages and page groups.Name | Description |
---|---|
AccessibilityObject | Gets the AccessibleObject assigned to the control. Inherited from Control. |
AccessibleDefaultActionDescription | Gets or sets the default action description of the control for use by accessibility client applications. Inherited from Control. |
AccessibleDescription | Gets or sets the description of the control used by accessibility client applications. Inherited from Control. |
AccessibleName | Gets or sets the name of the control used by accessibility client applications. Inherited from Control. |
AccessibleRibbon | Gets the object that provides the accessibility information. |
AccessibleRole | Gets or sets the accessible role of the control. Inherited from Control. |
AllowContentChangeAnimation | Gets or sets whether to use animation when changing pages. |
AllowCustomization | Gets or sets whether an end-user can customize the current RibbonControl at runtime. |
AllowDrop | Gets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control. |
AllowGlyphSkinning | Gets or sets whether glyphs for all BarItems within the RibbonControl should be painted using the text foreground color. |
AllowHtmlText | Gets or sets whether a BarItemLinks’ text within the current RibbonControl can be formatted using HTML tags. |
AllowInplaceLinks | For internal use. |
AllowKeyTips | Gets or sets whether Key Tips are enabled. |
AllowMdiChildButtons | Gets or sets whether MDI buttons for the current RibbonControl‘s child Ribbons are enabled. |
AllowMergeInvisibleItems static | Gets or sets whether invisible items within a parent RibbonControl should be merged with child RibbonControl‘s items with same captions. |
AllowMinimizeRibbon | Gets or sets whether the Ribbon can be minimized. If this property equals false, the ribbon context menu does not show the Minimize the Ribbon command, and the Minimized property is not in effect. |
AllowTrimPageText | Gets or sets whether text in Ribbon page tabs (RibbonPage.Text) is trimmed when reducing the Ribbon Control’s width. |
Anchor | Gets 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. |
ApplicationButtonAccessibleDescription | Gets or sets the description for the Application Button used by client accessibility applications. |
ApplicationButtonAccessibleName | Gets or sets the name for the Application Button which is used by client accessibility applications. |
ApplicationButtonAnimationLength | Gets or sets the length of the fading animation effect for the Application Button. |
ApplicationButtonDropDownControl | Gets or sets the drop-down control which is invoked when the Application Button is clicked. |
ApplicationButtonImageOptions | Provides access to options that allow you to specify and customize the Application Button‘s raster or vector icon. |
ApplicationButtonKeyTip | Gets or sets the Key Tip for the Application Button. |
ApplicationButtonSuperTip | Gets or sets a SuperToolTip for the Application Button. |
ApplicationButtonText | Gets or sets the Application Button‘s text. |
ApplicationCaption | Gets or sets the second portion of the RibbonForm’s caption which generally specifies the name of the current application. |
ApplicationDocumentCaption | Gets or sets the first portion of the RibbonForm’s caption which generally specifies the name of the active document. |
ApplicationIcon | Gets or sets an image displayed in the Application Button. |
AutoHiddenPagesMenuItem | For internal use. |
AutoHideEmptyItems | Gets or sets whether all empty items within this RibbonControl should be automatically hidden. |
AutoSaveLayoutToXml | Gets or sets whether the RibbonControl automatically saves its layout when the parent form is closed. |
AutoSaveLayoutToXmlPath | Gets or sets the path for an XML file, to which the auto-saved layout is written. |
AutoScrollOffset | Gets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control. |
AutoSize | This property is not supported by the RibbonControl class. |
AutoSizeItems | Gets or sets whether bar item links are displayed with the same width within a group. |
AutoUpdateMergedRibbons | Gets or sets whether items added to/removed from a child ribbon merged with this ribbon are automatically added to/removed from this ribbon. |
BackColor | Gets or sets the background color for the control. Inherited from Control. |
BackgroundImage | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
BackgroundImageLayout | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
BindingContext | Gets or sets the BindingContext for the control. Inherited from Control. |
Bottom | Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control. |
Bounds | Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control. |
ButtonGroupsLayout | Gets or sets the button group layout for all BarButtonGroup objects within this RibbonControl. |
ButtonGroupsVertAlign | Gets or sets the vertical alignment of button groups within Ribbon page groups. |
CanEnableIme protected | Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control. |
CanFocus | Gets a value indicating whether the control can receive focus. Inherited from Control. |
CanRaiseEvents protected | Determines if events can be raised on the control. Inherited from Control. |
CanSelect | Gets a value indicating whether the control can be selected. Inherited from Control. |
CaptionBarItemLinks | Provides access to bar item links displayed in the RibbonForm‘s caption area. |
CaptionBarMinWidth | Gets or sets the minimum width (in pixels) for the Ribbon caption bar. |
Capture | Gets or sets a value indicating whether the control has captured the mouse. Inherited from Control. |
Categories | Gets a collection of categories used to logically organize bar items. |
CausesValidation | Gets 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 static | Gets 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. |
ClientRectangle | Gets the rectangle that represents the client area of the control. Inherited from Control. |
ClientSize | Gets or sets the height and width of the client area of the control. Inherited from Control. |
ColorScheme | Gets or sets the color applied to specific RibbonControl elements. |
CommandLayout | Gets or sets the RibbonControl‘s command layout: single-row Simplified or default Classic. |
CompanyName | Gets the name of the company or creator of the application containing the control. Inherited from Control. |
Container | Gets the IContainer that contains the Component. Inherited from Component. |
ContainsFocus | Gets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control. |
ContextMenu | Overrides the ContextMenu property. |
Controller | Gets or sets the bar and dock controller that specifies default appearance settings for the Ribbon Control. |
Controls | Gets the collection of controls contained within the control. Inherited from Control. |
Created | Gets a value indicating whether the control has been created. Inherited from Control. |
CreateParams protected | Gets the required creation parameters when the control handle is created. Inherited from Control. |
Cursor | Gets or sets the cursor that is displayed when the mouse pointer is over the ControlBase control. Inherited from ControlBase. |
DataBindings | Gets the data bindings for the control. Inherited from Control. |
DefaultBackColor static | Gets the default background color of the control. Inherited from Control. |
DefaultCursor protected | Gets or sets the default cursor for the control. Inherited from Control. |
DefaultFont static | Gets the default font of the control. Inherited from Control. |
DefaultForeColor static | Gets the default foreground color of the control. Inherited from Control. |
DefaultImeMode protected | Gets the default Input Method Editor (IME) mode supported by the control. Inherited from Control. |
DefaultMargin protected | Gets the space, in pixels, that is specified by default between controls. Inherited from Control. |
DefaultMaximumSize protected | Gets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control. |
DefaultMinimumSize protected | Gets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control. |
DefaultPadding protected | Gets the internal spacing, in pixels, of the contents of a control. Inherited from Control. |
DefaultPageCategory | Provides access to pages associated with the default page category. |
DefaultSize protected | Gets the default size of the control. Inherited from Control. |
DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
DisableAccessibility static | Gets 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. |
DisplayRectangle | Gets the rectangle that represents the display area of the control. Inherited from Control. |
Disposing | Gets a value indicating whether the base Control class is in the process of disposing. Inherited from Control. |
Dock | This member overrides the Dock property. |
DoubleBuffered protected | Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control. |
DrawGroupCaptions | Gets or sets whether to draw captions for Ribbon Page Groups. |
DrawGroupsBorder | Obsolete. Gets or sets whether to draw borders for Ribbon Page Groups. |
DrawGroupsBorderMode | Gets or sets whether or not Ribbon page groups should display their borders and captions. |
EmptyAreaImageOptions | Provides access to options that specify a raster or vector image displayed in the ribbon’s empty area. |
Enabled | Gets or sets a value indicating whether the control can respond to user interaction. Inherited from Control. |
Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
ExpandCollapseItem | Provides access to the predefined button that expands/colapses the ribbon. |
ExternalRepository | Gets or sets the external editors repository. |
Focused | Gets a value indicating whether the control has input focus. Inherited from Control. |
Font | Gets or sets the control font. Inherited from ControlBase. |
FontHeight protected | Gets or sets the height of the font of the control. Inherited from Control. |
ForeColor | Gets or sets the foreground color of the control. Inherited from Control. |
FullScreen | Gets 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. |
GalleryAnimationLength | Gets or sets the length of the fading animation effect for gallery items. |
GroupAnimationLength | Gets or sets the length of the fading animation effect for Ribbon page groups. |
Handle | Gets the window handle that the control is bound to. Inherited from Control. |
HasChildren | Gets a value indicating whether the control contains one or more child controls. Inherited from Control. |
HeaderAreaImageOptions | Allows you to access settings that control the header area image. |
Height | Gets or sets the height of the control. Inherited from Control. |
HtmlImages | Gets or sets a collection of images that can be inserted into item captions using the image tag. |
Image | Gets or sets the custom background image for this RibbonControl. |
ImageAlignment | Gets or sets the alignment of a background Ribbon image. |
Images | Gets or sets the source of images that can be displayed within item links. |
ImeMode | Gets or sets the Input Method Editor (IME) mode of the control. Inherited from Control. |
ImeModeBase protected | Gets or sets the IME mode of a control. Inherited from Control. |
InvokeRequired | Gets 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. |
IsAccessible | Gets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control. |
IsDesignMode | Gets a value which indicates whether the Ribbon Control is currently in design mode. |
IsDisposed | Gets a value indicating whether the control has been disposed of. Inherited from Control. |
IsHandleCreated | Gets a value indicating whether the control has a handle associated with it. Inherited from Control. |
IsMirrored | Gets a value indicating whether the control is mirrored. Inherited from Control. |
IsRightToLeft | Gets whether the ControlBase‘s visual elements are actually aligned to support locales using right-to-left fonts. Inherited from ControlBase. |
ItemAnimationLength | Gets or sets the length of the fading animation effect for the RibbonControl’s bar item links. |
ItemPanelStyle | Gets 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. |
Items | Provides access to a Ribbon Control’s item collection. |
ItemsVertAlign | Gets or sets the vertical alignment of bar items within Ribbon page groups. |
KeyTipManager | Gets the key tip manager. |
LargeImages | Gets or sets the source of large images that can be displayed within item links. |
LayoutEngine | Gets a cached instance of the control’s layout engine. Inherited from Control. |
LayoutVersion | Gets 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. |
Left | Gets 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. |
Location | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control. |
Manager | Gets the Ribbon BarManager. |
Margin | Gets or sets the space between controls. Inherited from Control. |
MaximumSize | Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control. |
MaxItemId | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. |
MdiMergeStyle | Gets or sets if and when a merge mechanism is invoked in an MDI application. |
MergedCategories | Provides access to categories that have been merged into the Ribbon Control. |
MergedMessages | Gets a collection of messages from merged child ribbons. The Ribbon control displays these messages in the message bar. |
MergedPages | Provides access to pages that have been merged into the default category of the Ribbon Control. |
MergedRibbon | Gets the RibbonControl that has been merged into the current RibbonControl object. |
MergeOwner | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Messages | Gets a collection of messages displayed in the message bar. |
Minimized | Gets or sets whether the ribbon is minimized. |
MinimumSize | Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control. |
MiniToolbars | Provides access to the collection of RibbonMiniToolbar objects. |
ModifierKeys static | Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control. |
MoreCommandsItem | For internal use. |
MouseButtons static | Gets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control. |
MousePosition static | Gets the position of the mouse cursor in screen coordinates. Inherited from Control. |
Name | Gets or sets the name of the control. Inherited from Control. |
NotifyAccessibilityClients | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
OptionsAnimation | Provides access to animation settings for this RibbonControl. |
OptionsCustomizationForm | Provides access to the Customization Form‘s settings. |
OptionsExpandCollapseMenu | Gets the availability and behavior settings of the Ribbon Display Options popup menu. |
OptionsMenuMinWidth | Gets or sets the minimum width of the Display Options button’s dropdown window. |
OptionsPageCategories | Provides access to category settings. Categories are stored in the RibbonControl.Categories collection. |
OptionsSearchMenu | |
OptionsStubGlyphs | Provides access to options that modify a stub glyphs’ appearance. |
OptionsTouch | Provides access to properties that specify this RibbonControl‘s behavior on touch-input devices. |
Padding | This member is not supported by the RibbonControl. |
PageAnimationLength | Gets or sets the length of the fading animation effect for the RibbonControl’s page headers. |
PageCategories | Gets the collection of custom page categories, which allows contextual tab pages to be added and manipulated. |
PageCategoryAlignment | Gets or sets the alignment of custom page categories, which display contextual tab pages. |
PageHeaderItemLinks | Gets a collection of bar item links displayed at the right edge of the control in the same row with tab headers. |
PageHeaderMinWidth | Gets or sets the minimum allowed width of page headers. |
Pages | Provides access to the Ribbon Control’s main pages. |
Parent | Gets or sets the parent container of the control. Inherited from Control. |
PopupMenuAlignment | Gets or sets how popup menus associated with this RibbonControl should be aligned. |
PopupShowMode | Gets or sets whether nested popup sub-menus are displayed in cascaded or inplace mode. |
PreferredSize | Gets the size of a rectangular area into which the control can fit. Inherited from Control. |
ProductName | Gets the product name of the assembly containing the control. Inherited from Control. |
ProductVersion | Gets the version of the assembly containing the control. Inherited from Control. |
PropagatingImeMode protected static | Gets an object that represents a propagating IME mode. Inherited from Control. |
QuickToolbarItemLinks | Gets the collection of item links displayed in the Quick Access Toolbar. |
RecreatingHandle | Gets a value indicating whether the control is currently re-creating its handle. Inherited from Control. |
ReduceOperations | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Region | Gets or sets the window region associated with the control. Inherited from Control. |
RegistrationInfo | Gets the registration info for this RibbonControl. |
RenderRightToLeft protected | This property is now obsolete. Inherited from Control. |
RepositoryItems | Provides access to the control’s internal repository. |
ResizeRedraw protected | Gets or sets a value indicating whether the control redraws itself when resized. Inherited from Control. |
RibbonCaptionAlignment | Gets or sets the alignment of the ribbon caption in a Ribbon Form. |
RibbonStyle | Gets or sets the style of the RibbonControl. |
Right | Gets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control. |
RightToLeft | Gets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control. |
RowCount | For internal use. |
ScaleChildren protected | Gets a value that determines the scaling of child controls. Inherited from Control. |
SearchEditItem | Provides access to the bar item that represents the search box. For internal use. |
SearchItemPosition | Gets or sets the position of the Search box. |
SearchItemShortcut | Gets or sets the shortcut used to focus the search box. |
SearchRepositoryItem | Provides access to the repository item that represents the search box. For internal use. |
SelectedPage | Gets or sets the currently selected page. |
ShowApplicationButton | Gets or sets whether the Application Button is visible. |
ShowCategoryInCaption | Gets or sets whether category names are displayed in the RibbonForm’s title bar. |
ShowDisplayOptionsMenuButton | Gets 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. |
ShowExpandCollapseButton | Gets or sets whether the Ribbon Control displays a button that allows an end-user to hide/restore the RibbonControl’s pages. |
ShowFocusCues protected | Gets a value indicating whether the control should display focus rectangles. Inherited from Control. |
ShowFullScreenButton | Gets 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. |
ShowItemCaptionsInCaptionBar | Specifies whether or not bar item links from the RibbonControl.CaptionBarItemLinks collection should display their captions. |
ShowItemCaptionsInPageHeader | Gets or sets whether item links within page header area should display their captions. |
ShowItemCaptionsInQAT | Gets or sets whether bar item links within the Quick Access Toolbar should display their captions. |
ShowKeyboardCues protected | Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control. |
ShowMoreCommandsButton | Gets 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. |
ShowPageHeaders | Obsolete. Gets or sets whether page headers are displayed. |
ShowPageHeadersInFormCaption | Gets 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. |
ShowPageHeadersMode | Gets or sets page headers display mode. |
ShowPageKeyTipsMode | Gets or sets whether to display key tips for ribbon pages. |
ShowQatLocationSelector | Gets or sets whether the option that allows an end-user to change the Quick Access Toolbar location is displayed in the customization menus. |
ShowSearchItem | Gets or sets whether to display the search box that allows a user to find a bar item by its caption. |
ShowToolbarCustomizeItem | Gets or sets whether the customize item is displayed within the Quick Access Toolbar. |
SingleTapToShowKeyboard | Gets or sets whether users should tap editors once or twice to display the on-screen keyboard (when the application runs on touch-screen devices). |
Site | Gets or sets the site of the control. Inherited from Control. |
Size | Gets or sets the height and width of the control. Inherited from Control. |
StatusBar | Gets or sets the RibbonStatusBar object linked with the current Ribbon Control. |
TabIndex | This member overrides the TabIndex property. |
TabStop | This member overrides the TabStop property. |
Tag | Gets or sets the object that contains data about the control. Inherited from Control. |
Text | This member overrides the Text property. |
Toolbar | Provides access to the Quick Access Toolbar. |
ToolbarLocation | Gets or sets the position of the Quick Access Toolbar. |
ToolTipController | Gets or sets the tooltip controller component that controls the appearance, position and content of tooltips displayed by elements of the RibbonControl. |
Top | Gets 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. |
TopLevelControl | Gets 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. |
TotalPageCategory | Allows you to return all pages and visible pages owned by the RibbonControl. |
TransparentEditors | This property is provided for backward compatibility. Use the RibbonControl.TransparentEditorsMode property instead. |
TransparentEditorsMode | Gets or sets whether specific in-place editors, when focused, are painted using a transparent background color. |
UseWaitCursor | Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control. |
ViewInfo | Gets the Ribbon Control’s view information. |
Visible | Gets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control. |
Width | Gets or sets the width of the control. Inherited from Control. |
WindowTarget | This property is not relevant for this class. Inherited from Control. |
See Also