Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressBars Suite > API Reference > dxRibbon > TdxCustomRibbon > Members
All docs
V24.2
VCL Controls
What's New
Express Cross Platform Library
ExpressQuantumGrid Suite
ExpressEditors Library
ExpressBars Suite
Fundamentals
Concepts
Customization Capabilities
End-User Capabilities
How To...
Examples
API Reference
cxBarEditItem
dxBar
dxBarApplicationMenu
dxBarCustomCustomizationForm
dxBarDBNav
dxBarExtDBItems
dxBarExtItems
dxOfficeSearchBox
dxRibbon
IdxRibbonApplicationMenu
IdxRibbonFormNonClientDraw
IdxRibbonListener
IdxRibbonMouseWheelReceiver
IdxRibbonToolbarContainer
TdxBarApplicationMenu
TdxCustomRibbon
Members
Constructors
Properties
Methods
Events
TdxQuickAccessToolbarPosition
TdxRibbon
TdxRibbonApplicationButton
TdxRibbonApplicationMenuClickEvent
TdxRibbonApplicationMenuDisplayMode
TdxRibbonAssignedFont
TdxRibbonAssignedFonts
TdxRibbonCaptionAreaSearchToolbar
TdxRibbonCaptionAreaSearchToolbarAlignment
TdxRibbonContext
TdxRibbonContexts
TdxRibbonCustomButtonPersistent
TdxRibbonCustomPopupComponent
TdxRibbonCustomPopupMenu
TdxRibbonCustomToolbar
TdxRibbonCustomizationFormMode
TdxRibbonEvent
TdxRibbonFonts
TdxRibbonHelpButton
TdxRibbonHideMinimizedByClickEvent
TdxRibbonLayout
TdxRibbonMergeKind
TdxRibbonMergeOption
TdxRibbonMergeOptions
TdxRibbonOptionsFading
TdxRibbonPopupMenu
TdxRibbonPopupMenuItem
TdxRibbonPopupMenuItems
TdxRibbonQuickAccessGroupButton
TdxRibbonQuickAccessToolbar
TdxRibbonTab
TdxRibbonTabAreaSearchToolbar
TdxRibbonTabAreaToolbar
TdxRibbonTabChangingEvent
TdxRibbonTabCollection
TdxRibbonTabGroup
TdxRibbonTabGroupAssignedValue
TdxRibbonTabGroupAssignedValues
TdxRibbonTabGroupClass
TdxRibbonTabGroupNotifyEvent
TdxRibbonTabGroupRestriction
TdxRibbonTabGroups
dxRibbonContextualTabLabelShowAnimationTime
dxRibbonDefaultMergeOptions
dxRibbonDefaultPopupMenuItems
dxRibbonTabGroupContentShowAnimationTime
dxRibbonTabStateChangeAnimationTime
dxRibbonBackstageView
dxRibbonBackstageViewGalleryControl
dxRibbonColorGallery
dxRibbonForm
dxRibbonGallery
dxRibbonMiniToolbar
dxRibbonRadialMenu
dxRibbonSkins
dxRibbonStatusBar
dxSkinChooserGallery
dxStatusBar
dxTabbedMDI
ExpressCharts Suite
ExpressRichEditControl Suite
ExpressSkins Library
ExpressScheduler Suite
ExpressSpreadSheet Suite
ExpressQuantumTreeList Suite
ExpressPDFViewer Suite
ExpressPrinting System
ExpressLayoutControl Suite
ExpressNavBar Suite
ExpressPivotGrid Suite
ExpressVerticalGrid Suite
ExpressDocking Library
ExpressMemData
ExpressDataController
ExpressSpellChecker Suite
ExpressMapControl Suite
ExpressGanttControl Suite
ExpressGaugeControl Suite
ExpressTileControl Suite
ExpressFlowChart Suite
ExpressFlowChart Editor
ExpressOrgChart Suite
ExpressPageControl Suite
ExpressWizardControl Suite

TdxCustomRibbon Members

The base class for the Ribbon control.

Constructors

Name Description
Create(TComponent) Inherited from TComponent.
CreateParented(HWND) Inherited from TWinControl.

Properties

Name Description
Action Inherited from TControl.
ActiveCanvas Provides access to the control’s GDI-based canvas. Inherited from TcxControl.
ActiveTab Provides access to the currently selected Ribbon tab.
Align Inherited from TControl.
AlignDisabled Inherited from TWinControl.
AlignWithMargins Inherited from TControl.
Anchors Inherited from TControl.
ApplicationButton Specifies the Ribbon Application Button.
AutoSize Inherited from TControl.
BackgroundImage Specifies the background image for the Ribbon tab area and the Ribbon Form’s non-client area painted using the Ribbon.
BarManager Specifies the bar manager.
BevelEdges Inherited from TWinControl.
BevelInner Inherited from TWinControl.
BevelKind Inherited from TWinControl.
BevelOuter Inherited from TWinControl.
BevelWidth Inherited from TWinControl.
BiDiMode Inherited from TControl.
BorderSize protected Inherited from TcxControl.
BorderStyle protected Specifies the control’s border style. Inherited from TcxControl.
BorderWidth Inherited from TWinControl.
Bounds Returns the control’s boundaries. Inherited from TcxControl.
BoundsRect Inherited from TControl.
Brush Inherited from TWinControl.
Canvas Provides access to the control’s GDI-based canvas. Inherited from TcxControl.
CapitalizeTabCaptions Specifies if Ribbon tab captions are capitalized.
Caption Inherited from TControl.
CaptionAreaSearchToolbar Provides access to the settings of the search toolbar displayed in the Ribbon form caption area.
ClientBounds Returns the control’s client area. Inherited from TcxControl.
ClientHeight Inherited from TControl.
ClientOrigin Inherited from TControl.
ClientRect Inherited from TControl.
ClientWidth Inherited from TControl.
Color Inherited from TControl.
ColorSchemeAccent Specifies the color accent (palette) for built-in Ribbon skins.
ColorSchemeHandlers A list of registered event handlers that update paint styles of associated controls when the Ribbon changes its color scheme.
ColorSchemeName Specifies the name of the active built-in or common skin applied to the Ribbon control.
ComObject Inherited from TComponent.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
Constraints Inherited from TControl.
Contexts Provides access to the Ribbon’s collection of application contexts.
ControlCount Inherited from TWinControl.
Controls Inherited from TWinControl.
ControlState Inherited from TControl.
ControlStyle Inherited from TControl.
Ctl3D Inherited from TWinControl.
CurrentPPI Inherited from TControl.
Cursor Inherited from TControl.
CustomHint Inherited from TControl.
DefaultUseGlobalSkin Specifies if all Ribbon controls in the application automatically update their appearance from the skin and palette defined application-wide.
DesignInfo Inherited from TComponent.
DockClientCount Inherited from TWinControl.
DockClients Inherited from TWinControl.
DockManager Inherited from TWinControl.
DockOrientation Inherited from TControl.
DockSite Inherited from TWinControl.
DocumentName Specifies the display name of the currently active document.
DoubleBuffered Inherited from TWinControl.
DragAndDropObject Inherited from TcxControl.
DragAndDropObjectClass Inherited from TcxControl.
DragAndDropState Inherited from TcxControl.
DragCursor Inherited from TControl.
DragKind Inherited from TControl.
DragMode Inherited from TControl.
Enabled Inherited from TControl.
EnableTabAero Specifies if form transparency is enabled.
ExplicitHeight Inherited from TControl.
ExplicitLeft Inherited from TControl.
ExplicitTop Inherited from TControl.
ExplicitWidth Inherited from TControl.
Floating Inherited from TControl.
FloatingDockSiteClass Inherited from TControl.
FocusOnClick protected Specifies if clicking the control focuses it. Inherited from TcxControl.
Font Inherited from TControl.
Fonts Specifies font options for Ribbon elements.
Handle Inherited from TWinControl.
Height Inherited from TControl.
HelpButton Specifies the Ribbon Help Button.
HelpButtonScreenTip Specifies a ScreenTip for the Ribbon Help Button.
HelpContext Inherited from TControl.
HelpKeyword Inherited from TControl.
HelpType Inherited from TControl.
Hidden Gets whether the Ribbon is hidden.
Hint Specifies a hint message for the control. Inherited from TcxControl.
HostDockSite Inherited from TControl.
HScrollBar protected Inherited from TcxControl.
HScrollBarVisible protected Inherited from TcxControl.
ImeMode Inherited from TWinControl.
ImeName Inherited from TWinControl.
IsDesigning Identifies if the control is being modified by the form designer. Inherited from TcxControl.
IsDestroying Identifies if the control is about to be destroyed. Inherited from TcxCustomControl.
IsDrawingLocked Inherited from TWinControl.
IsFocused Identifies if the control has focus. Inherited from TcxControl.
IsLoading Identifies if the control is being loaded. Inherited from TcxControl.
IsPopupGroupsMode
Keys protected Inherited from TcxControl.
Layout protected Specifies the active layout type of the Ribbon UI if a supported Ribbon UI Style is active.
Left Inherited from TControl.
LockCount
LookAndFeel protected Provides access to the control’s look & feel settings. Inherited from TcxControl.
LookAndFeelPainter protected Inherited from TcxControl.
LRDockWidth Inherited from TControl.
Margins Inherited from TControl.
MinimizeOnTabDblClick Specifies whether the Ribbon can be minimized on a Ribbon Tab double-click.
MouseCapture Inherited from TControl.
MouseCaptureObject Provides access to the dragged object during a drag-and-drop operation. Inherited from TcxControl.
MouseDownPos Specifies the mouse pointer position when an OnMouseDown event occurs. Inherited from TcxControl.
MouseInClient Inherited from TWinControl.
Name Inherited from TComponent.
Observers Inherited from TComponent.
OptionsFading Provides access to the fading animation settings of the Ribbon control’s elements.
Owner Inherited from TComponent.
Padding Inherited from TWinControl.
Parent Inherited from TControl.
ParentBackground protected Inherited from TcxControl.
ParentBiDiMode Inherited from TControl.
ParentColor Inherited from TControl.
ParentCtl3D Inherited from TWinControl.
ParentCustomHint Inherited from TControl.
ParentDoubleBuffered Inherited from TWinControl.
ParentFont Inherited from TControl.
ParentShowHint Inherited from TControl.
ParentWindow Inherited from TWinControl.
PixelsPerInch Inherited from TWinControl.
PopupMenu protected Specifies the popup menu associated with the control. Inherited from TcxControl.
PopupMenuItems Specifies menu item groups to be shown in the Ribbon context menu.
QuickAccessToolbar Provides access to the Ribbon Quick Access Toolbar’s settings.
RaiseOnNonMainThreadUsage Inherited from TControl.
RedrawDisabled Inherited from TWinControl.
ScaleFactor Inherited from TControl.
ScrollBars protected Inherited from TcxControl.
ShowHint Inherited from TControl.
Showing Inherited from TWinControl.
ShowMinimizeButton Switches the visibility of the Minimize button on the Ribbon’s right side.
ShowTabGroups Specifies whether tabbed pages are shown in the Ribbon.
ShowTabHeaders Specifies whether tab headers are shown in the Ribbon.
Style Specifies the Ribbon UI style.
StyleElements Inherited from TControl.
StyleName Inherited from TControl.
SupportNonClientDrawing Specifies if the Ribbon control decorates non-client areas of the parent form.
TabAreaSearchToolbar Provides access to the settings of the search toolbar displayed in the tab area of the Ribbon control.
TabAreaToolbar Provides access to the Ribbon Tab Area Toolbar‘s settings.
TabCount Gets a count of Ribbon tabs.
TabOrder Inherited from TWinControl.
Tabs Provides access to a collection of Ribbon tabs.
TabStop Inherited from TcxControl.
Tag Inherited from TComponent.
TBDockHeight Inherited from TControl.
Text Inherited from TControl.
TipMode Inherited from TWinControl.
Top Inherited from TControl.
Touch Inherited from TControl.
Transparent protected Specifies if the control is transparent in GDI render mode. Inherited from TcxControl.
UndockHeight Inherited from TControl.
UndockWidth Inherited from TControl.
UseDockManager Inherited from TWinControl.
UseGlobalSkin Specifies if the Ribbon control automatically updates its appearance from the skin and palette defined application-wide.
VCLComObject Inherited from TComponent.
Visible Inherited from TControl.
VisibleDockClientCount Inherited from TWinControl.
VisibleTabCount Gets a count of Ribbon tabs that are visible in the Ribbon.
VisibleTabs Provides indexed access to the visible Ribbon tab at the position specified by the zero-based Index parameter.
VScrollBar protected Inherited from TcxControl.
VScrollBarVisible protected Inherited from TcxControl.
Width Inherited from TControl.
WindowProc Inherited from TControl.

Methods

Name Description
AcceptMousePosForClick(Integer,Integer) Inherited from TcxControl.
AddFontListener(IcxFontListener) Inherited from TcxControl.
AddListener(IdxRibbonListener)
ApplicationMenuPopup Invokes the Ribbon Application Menu.
AreGroupsVisible
Assign(TPersistent) Inherited from TPersistent.
AssignTo(TPersistent) Inherited from TPersistent.
BeginDrag(Boolean,Integer) Inherited from TControl.
BeginDragAndDrop Inherited from TcxControl.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject) Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject) Inherited from TComponent.
BeginInvoke(TProc,TObject) Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject) Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject) Inherited from TComponent.
BeginUpdate Postpones all Ribbon UI redraw operations that reflect any content or appearance change until an EndUpdate procedure call.
BringToFront Inherited from TControl.
Broadcast(Untyped) Inherited from TWinControl.
CanFocus Inherited from TWinControl.
CanFocusEx Inherited from TcxControl.
ChangeScale(Integer,Integer) Inherited from TControl.
CheckHide Recalculates the Ribbon UI layout when the parent form’s height changes.
CheckNonMainThreadUsage Inherited from TControl.
Click Inherited from TControl.
ClientToParent(TPoint,TWinControl) Inherited from TControl.
ClientToScreen(TPoint) Inherited from TControl.
ClientToScreen(TRect) Inherited from TControl.
CloseTabGroupsPopupWindow
ConstrainedResize(Integer,Integer,Integer,Integer) Inherited from TControl.
ContainsControl(TControl) Inherited from TWinControl.
ContainsToolBar(TdxBar)
ControlAtPos(TPoint,Boolean,Boolean,Boolean) Inherited from TWinControl.
CreateParentedControl(HWND) Inherited from TWinControl.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
DisableAlign Inherited from TWinControl.
Dock(TWinControl,TRect) Inherited from TControl.
DockDrop(TDragDockObject,Integer,Integer) Inherited from TWinControl.
DragDrop(TObject,Integer,Integer) Inherited from TControl.
Dragging Inherited from TControl.
DrawTextBiDiModeFlags(Longint) Inherited from TControl.
DrawTextBiDiModeFlagsReadingOnly Inherited from TControl.
EnableAlign Inherited from TWinControl.
EndDrag(Boolean) Inherited from TControl.
EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
EndUpdate Applies all pending changes and redraws the Ribbon control after a BeginUpdate procedure call.
Equals(TObject) Inherited from TObject.
ExecuteAction(TBasicAction) Inherited from TComponent.
FindChildControl(String) Inherited from TWinControl.
FindComponent(String) Inherited from TComponent.
FinishDragAndDrop(Boolean) Inherited from TcxControl.
FlipChildren(Boolean) Inherited from TWinControl.
Focused Inherited from TWinControl.
FreeNotification(TComponent) Inherited from TComponent.
FreeOnRelease Inherited from TComponent.
GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
GetControlsAlignment Inherited from TControl.
GetDragImages Inherited from TControl.
GetHashCode Inherited from TObject.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
GetParentComponent Inherited from TComponent.
GetStyleName Inherited from TControl.
GetSystemMetrics(Integer) Inherited from TControl.
GetTabAtPos(Integer,Integer) Returns the Ribbon tab by its relative screen coordinates.
GetTabControlList(TList) Inherited from TWinControl.
GetTabOrderList(TList) Inherited from TWinControl.
GetTextBuf(PChar,Integer) Inherited from TControl.
GetTextLen Inherited from TControl.
HandleAllocated Inherited from TWinControl.
HandleNeeded Inherited from TWinControl.
HasParent Inherited from TComponent.
Hide Inherited from TControl.
InitiateAction Inherited from TControl.
InsertComponent(TComponent) Inherited from TComponent.
InsertControl(TControl) Inherited from TWinControl.
Invalidate Inherited from TControl.
InvalidateRect(TRect,Boolean) Adds a specified portion of the control’s client area to the window update region. Inherited from TcxControl.
InvalidateRect(TRect)
InvalidateRgn(TcxRegion,Boolean) Inherited from TcxControl.
InvalidateWithChildren Inherited from TcxControl.
IsCustomStyleActive Inherited from TControl.
IsImplementorOf(IInterface) Inherited from TComponent.
IsLightStyleColor(TColor) Inherited from TControl.
IsMerged
IsMouseInPressedArea(Integer,Integer) Inherited from TcxControl.
IsRightToLeft Inherited from TControl.
Loaded Inherited from TComponent.
LockDrawing Inherited from TWinControl.
LockScrollBars Inherited from TcxControl.
ManualDock(TWinControl,TControl,TAlign) Inherited from TControl.
ManualFloat(TRect) Inherited from TControl.
Merge(TdxCustomRibbon,TdxRibbonMergeOptions)
MouseDown(TMouseButton,TShiftState,Integer,Integer) Inherited from TControl.
MouseMove(TShiftState,Integer,Integer) Inherited from TControl.
MouseUp(TMouseButton,TShiftState,Integer,Integer) Inherited from TControl.
MouseWheelHandler(TMessage) Inherited from TControl.
Notification(TComponent,TOperation) Inherited from TComponent.
PaintTo(HDC,Integer,Integer) Inherited from TWinControl.
PaintTo(TCanvas,Integer,Integer) Inherited from TWinControl.
ParentToClient(TPoint,TWinControl) Inherited from TControl.
Perform(Cardinal,WPARAM,LPARAM) Inherited from TControl.
Perform(Cardinal,WPARAM,PChar) Inherited from TControl.
Perform(Cardinal,WPARAM,TRect) Inherited from TControl.
PostMouseMove Inherited from TcxControl.
PostMouseMove(TPoint) Inherited from TcxControl.
PreProcessMessage(TMsg) Inherited from TWinControl.
Realign Inherited from TWinControl.
ReferenceInterface(IInterface,TOperation) Inherited from TComponent.
Refresh Inherited from TControl.
RemoveComponent(TComponent) Inherited from TComponent.
RemoveControl(TControl) Inherited from TWinControl.
RemoveFontListener(IcxFontListener) Inherited from TcxControl.
RemoveFreeNotification(TComponent) Inherited from TComponent.
RemoveListener(IdxRibbonListener)
Repaint Inherited from TControl.
ReplaceDockedControl(TControl,TWinControl,TControl,TAlign) Inherited from TControl.
ScaleBy(Integer,Integer) Inherited from TWinControl.
ScaleForPPI(Integer) Inherited from TControl.
ScaleRectSize(TRect) Inherited from TControl.
ScaleValue(Double) Inherited from TControl.
ScaleValue(Integer) Inherited from TControl.
ScaleValue(TPoint) Inherited from TControl.
ScaleValue(TRect) Inherited from TControl.
ScaleValue(TSize) Inherited from TControl.
ScreenToClient(TPoint) Inherited from TControl.
ScreenToClient(TRect) Inherited from TControl.
ScrollBy(Integer,Integer) Inherited from TWinControl.
ScrollContent(TcxDirection) Inherited from TcxControl.
ScrollWindow(Integer,Integer,TRect) Inherited from TcxControl.
SendToBack Inherited from TControl.
SetBounds(Integer,Integer,Integer,Integer) Inherited from TControl.
SetDesignVisible(Boolean) Inherited from TControl.
SetFocus Inherited from TWinControl.
SetParentComponent(TComponent) Inherited from TComponent.
SetScrollBarInfo(TScrollBarKind,Integer,Integer,Integer,Integer,Integer,Boolean,Boolean) Inherited from TcxControl.
SetSubComponent(Boolean) Inherited from TComponent.
SetTextBuf(PChar) Inherited from TControl.
Show Inherited from TControl.
ShowCustomizationForm(TdxRibbonCustomizationFormMode)
ShowTabGroupsPopupWindow Renders a tab page as a drop-down window.
StartDrag(TDragObject) Inherited from TcxControl.
SystemInfoChanged(Cardinal) Inherited from TcxControl.
ToString Inherited from TObject.
TranslationChanged Inherited from TcxControl.
UnlockDrawing Inherited from TWinControl.
UnlockScrollBars Inherited from TcxControl.
Unmerge(TdxCustomRibbon)
Update Inherited from TControl.
UpdateAction(TBasicAction) Inherited from TComponent.
UpdateControlState Inherited from TWinControl.
UpdateWithChildren Inherited from TcxControl.
UseRightToLeftAlignment Inherited from TControl.
UseRightToLeftReading Inherited from TControl.
UseRightToLeftScrollBar Inherited from TControl.
WndProc(TMessage) Inherited from TControl.

Events

Name Description
OnAlignInsertBefore Inherited from TWinControl.
OnAlignPosition Inherited from TWinControl.
OnApplicationMenuClick Fires when the Ribbon Application Menu is about to be displayed on-screen.
OnCanResize Inherited from TControl.
OnClick Inherited from TControl.
OnConstrainedResize Inherited from TControl.
OnContextPopup Inherited from TControl.
OnDblClick Inherited from TControl.
OnDockDrop Inherited from TWinControl.
OnDockOver Inherited from TWinControl.
OnDragDrop Inherited from TControl.
OnDragOver Inherited from TControl.
OnEndDock Inherited from TControl.
OnEndDrag Inherited from TControl.
OnEnter Inherited from TWinControl.
OnExit Inherited from TWinControl.
OnFocusChanged protected Inherited from TcxControl.
OnGesture Inherited from TControl.
OnGetSiteInfo Inherited from TWinControl.
OnHelpButtonClick Fires after the Ribbon Help Button has been clicked.
OnHideMinimizedByClick Enables you to provide custom processing for mouse clicks that result in hiding a minimized Ribbon.
OnKeyDown Inherited from TWinControl.
OnKeyPress Inherited from TWinControl.
OnKeyUp Inherited from TWinControl.
OnMinimizedChanged Enables you to respond to Ribbon minimization or restoration.
OnMoreCommandsExecute Fires after the More Commands… item in the Ribbon Quick Access Toolbar‘s dropdown menu has been clicked.
OnMouseActivate Inherited from TControl.
OnMouseDown Inherited from TControl.
OnMouseEnter protected Occurs when the mouse pointer enters into the control. Inherited from TcxControl.
OnMouseLeave protected Occurs when the mouse pointer leaves the control. Inherited from TcxControl.
OnMouseMove Inherited from TControl.
OnMouseUp Inherited from TControl.
OnMouseWheel Inherited from TControl.
OnMouseWheelDown Inherited from TControl.
OnMouseWheelUp Inherited from TControl.
OnResize Inherited from TControl.
OnStartDock Inherited from TControl.
OnStartDrag Inherited from TControl.
OnTabChanged Fires after an active Ribbon tab has been changed.
OnTabChanging Fires when an active Ribbon tab is about to be changed.
OnTabGroupCollapsed Fires after the AGroup has been collapsed within the Ribbon tab passed as the ATab parameter.
OnTabGroupExpanded Fires after the AGroup has been expanded within the Ribbon tab passed as the ATab parameter.
OnUnDock Inherited from TWinControl.
See Also