Back to Devexpress

RibbonControl Events

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

latest32.0 KB
Original Source

RibbonControl Events

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

NameDescription
AfterApplicationButtonContentControlHiddenFires after the dropdown control associated with the Application Button is hidden.
ApplicationButtonClickOccurs when the Application Button is clicked.
ApplicationButtonDoubleClickFires when the Application Button is double-clicked.
AutoSizeChangedThis event is not relevant for this class. Inherited from Control.
BackColorChangedOccurs when the value of the BackColor property changes. Inherited from Control.
BackgroundImageChangedOccurs when the value of the BackgroundImage property changes. Inherited from Control.
BackgroundImageLayoutChangedOccurs when the BackgroundImageLayout property changes. Inherited from Control.
BeforeApplicationButtonContentControlShowFires when the Application Button‘s associated control (RibbonControl.ApplicationButtonDropDownControl) is about to be displayed.
BeforeLoadLayoutFires before a layout is restored from a storage (a stream, xml file, or the system registry).
BeforeUnMergeRaises before this RibbonControl is unmerged and allows you to react to this upcoming change.
BindingContextChangedOccurs when the value of the BindingContext property changes. Inherited from Control.
CausesValidationChangedOccurs when the value of the CausesValidation property changes. Inherited from Control.
ChangeUICuesOccurs when the focus or keyboard user interface (UI) cues change. Inherited from Control.
ClickOccurs when the control is clicked. Inherited from Control.
ClientSizeChangedOccurs when the value of the ClientSize property changes. Inherited from Control.
ColorSchemeChangedFires when the RibbonControl.ColorScheme property’s value is changed.
CommandLayoutChangedFires when the RibbonControl.CommandLayout property value changes.
ContextMenuChangedOccurs when the value of the ContextMenu property changes. Inherited from Control.
ContextMenuStripChangedOccurs when the value of the ContextMenuStrip property changes. Inherited from Control.
ControlAddedOccurs when a new control is added to the Control.ControlCollection. Inherited from Control.
ControlRemovedOccurs when a control is removed from the Control.ControlCollection. Inherited from Control.
CursorChangedOccurs when the value of the Cursor property changes. Inherited from Control.
CustomDrawItemAllows you to manually paint any BarButtonItemLink within this RibbonControl.
CustomizationFormShowingFires when the Customization Form is about to be displayed and allows you to customize the form.
CustomizeQatMenuFires when the Quick Access Toolbar customization menu is about to be displayed, allowing commands in the menu to be customized.
CustomizeSearchMenuFires when the query in the search box changes and allows you to customize search results.
CustomSearchItemPositionAllows you to align the Search box within the header of the Ribbon form.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DockChangedOccurs when the value of the Dock property changes. Inherited from Control.
DoubleClickOccurs when the control is double-clicked. Inherited from Control.
DragDropOccurs when a drag-and-drop operation is completed. Inherited from Control.
DragEnterOccurs when an object is dragged into the control’s bounds. Inherited from Control.
DragLeaveOccurs when an object is dragged out of the control’s bounds. Inherited from Control.
DragOverOccurs when an object is dragged over the control’s bounds. Inherited from Control.
EnabledChangedOccurs when the Enabled property value has changed. Inherited from Control.
EnterOccurs when the control is entered. Inherited from Control.
ExpandCollapseMenuShowingAllows you to customize the Ribbon menu or prevent it from being displayed based on a condition.
FontChangedOccurs when the Font property value changes. Inherited from Control.
ForeColorChangedOccurs when the ForeColor property value changes. Inherited from Control.
GiveFeedbackOccurs during a drag operation. Inherited from Control.
GotFocusOccurs when the control receives focus. Inherited from Control.
HandleCreatedOccurs when a handle is created for the control. Inherited from Control.
HandleDestroyedOccurs when the control’s handle is in the process of being destroyed. Inherited from Control.
HelpRequestedOccurs when the user requests help for a control. Inherited from Control.
HyperlinkClickOccurs when a hyperlink within the current RibbonControl is clicked.
ImeModeChangedOccurs when the ImeMode property has changed. Inherited from Control.
InvalidatedOccurs when a control’s display requires redrawing. Inherited from Control.
InvalidSaveRestoreLayoutExceptionFires whenever saving or loading a RibbonControl‘s layout fails.
ItemClickFires when a link within the Ribbon Control is clicked.
ItemPressFires after a links has been pressed.
ItemRightClickOccurs when a user right-clicks an item in the RibbonControl.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from Control.
KeyPressOccurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control.
KeyUpOccurs when a key is released while the control has focus. Inherited from Control.
LayoutOccurs when a control should reposition its child controls. Inherited from Control.
LayoutUpgradeFires when a layout is restored from storage (a stream, xml file, or system registry). This event occurs only when layout versions (see the LayoutVersion property) differ.
LeaveOccurs when the input focus leaves the control. Inherited from Control.
LocationChangedOccurs when the Location property value has changed. Inherited from Control.
LostFocusOccurs when the control loses focus. Inherited from Control.
MarginChangedOccurs when the control’s margin changes. Inherited from Control.
MergeAllows you to perform additional customizations after another Ribbon Control has been merged into the current RibbonControl.
MessageClosedOccurs after a message is closed and allows you to handle button clicks.
MinimizedChangedAllows you to respond to minimizing/restoring the RibbonControl’s pages.
MinimizedRibbonHidingProvides access to the collapsed ribbon that is displayed in a pop-up and is in the process of being hidden.
MinimizedRibbonShowingProvides access to the collapsed ribbon, which is about to appear in a pop-up.
MouseCaptureChangedOccurs when the control loses mouse capture. Inherited from Control.
MouseClickOccurs when the control is clicked by the mouse. Inherited from Control.
MouseDoubleClickOccurs when the control is double clicked by the mouse. Inherited from Control.
MouseDownOccurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control.
MouseEnterOccurs when the mouse pointer enters the control. Inherited from Control.
MouseHoverOccurs when the mouse pointer rests on the control. Inherited from Control.
MouseLeaveOccurs when the mouse pointer leaves the control. Inherited from Control.
MouseMoveOccurs when the mouse pointer is moved over the control. Inherited from Control.
MouseUpOccurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control.
MouseWheelOccurs when the mouse wheel moves while the control has focus. Inherited from Control.
MoveOccurs when the control is moved. Inherited from Control.
PaddingChangedOccurs when the control’s padding changes. Inherited from Control.
PageCategoryClickOccurs when a user clicks a category caption. This event is not raised when any other element that belongs to this category (e.g., a page header, a page group, an bar item) is clicked.
PageGroupCaptionButtonClickEnables you to perform actions when end-users click group caption buttons.
PaintOccurs when the control is redrawn. Inherited from Control.
ParentChangedOccurs when the Parent property value changes. Inherited from Control.
PreviewKeyDownOccurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control.
QueryAccessibilityHelpOccurs when AccessibleObject is providing help to accessibility applications. Inherited from Control.
QueryContinueDragOccurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control.
RegionChangedOccurs when the value of the Region property changes. Inherited from Control.
ResetLayoutOccurs when the current RibbonControl‘s control is being reset to defaults.
ResizeOccurs when the control is resized. Inherited from Control.
RibbonStyleChangedOccurs each time the current RibbonControl‘s RibbonControl.RibbonStyle property value is changed.
RightToLeftChangedOccurs when the RightToLeft property value changes. Inherited from Control.
ScreenModeChangedFires when the RibbonControl.FullScreen property value changes.
SearchMenuEnterPressedOccurs when a user presses Enter in the search box.
SelectedPageChangedFires after the selected page has been changed.
SelectedPageChangingFires before a specific Ribbon Page is activated.
ShowCustomizationMenuOccurs before the RibbonControl’s Customization Menu is displayed.
SizeChangedOccurs when the Size property value changes. Inherited from Control.
StyleChangedOccurs when the control style changes. Inherited from Control.
SystemColorsChangedOccurs when the system colors change. Inherited from Control.
TabIndexChangedOccurs when the TabIndex property value changes. Inherited from Control.
TabStopChangedOccurs when the TabStop property value changes. Inherited from Control.
TextChangedOccurs when the Text property value changes. Inherited from Control.
ToolbarLocationChangedFires after the value of the RibbonControl.ToolbarLocation property has been changed.
UnMergeAllows you to perform additional customizations after another Ribbon Control has been unmerged from the current RibbonControl.
ValidatedOccurs when the control is finished validating. Inherited from Control.
ValidatingOccurs when the control is validating. Inherited from Control.
VisibleChangedOccurs when the Visible property value changes. Inherited from Control.

See Also

RibbonControl Class

RibbonControl Members

DevExpress.XtraBars.Ribbon Namespace