Back to Devexpress

TdxRibbon Members

vcl-dxribbon-dot-tdxribbon-dot-underscore-members.md

latest79.1 KB
Original Source

TdxRibbon Members

A Ribbon control.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.
CreateParented(HWND)Inherited from TWinControl.

Properties

NameDescription
ActionInherited from TControl.
ActiveCanvasProvides access to the control’s GDI-based canvas. Inherited from TcxControl.
ActiveTabProvides access to the currently selected Ribbon tab. Inherited from TdxCustomRibbon.
AlignInherited from TControl.
AlignDisabledInherited from TWinControl.
AlignWithMarginsInherited from TControl.
AnchorsInherited from TControl.
ApplicationButtonSpecifies the Ribbon Application Button. Inherited from TdxCustomRibbon.
AutoSizeInherited from TControl.
BackgroundImageSpecifies the background image for the Ribbon tab area and the Ribbon Form’s non-client area painted using the Ribbon. Inherited from TdxCustomRibbon.
BarManagerSpecifies the bar manager. Inherited from TdxCustomRibbon.
BevelEdgesInherited from TWinControl.
BevelInnerInherited from TWinControl.
BevelKindInherited from TWinControl.
BevelOuterInherited from TWinControl.
BevelWidthInherited from TWinControl.
BiDiModeInherited from TControl.
BorderSize protectedInherited from TcxControl.
BorderStyle protectedSpecifies the control’s border style. Inherited from TcxControl.
BorderWidthInherited from TWinControl.
BoundsReturns the control’s boundaries. Inherited from TcxControl.
BoundsRectInherited from TControl.
BrushInherited from TWinControl.
CanvasProvides access to the control’s GDI-based canvas. Inherited from TcxControl.
CapitalizeTabCaptionsSpecifies if Ribbon tab captions are capitalized. Inherited from TdxCustomRibbon.
CaptionInherited from TControl.
CaptionAreaSearchToolbarProvides access to the settings of the search toolbar displayed in the Ribbon form caption area. Inherited from TdxCustomRibbon.
ClientBoundsReturns the control’s client area. Inherited from TcxControl.
ClientHeightInherited from TControl.
ClientOriginInherited from TControl.
ClientRectInherited from TControl.
ClientWidthInherited from TControl.
ColorInherited from TControl.
ColorSchemeAccentSpecifies the color accent (palette) for built-in Ribbon skins. Inherited from TdxCustomRibbon.
ColorSchemeHandlersA list of registered event handlers that update paint styles of associated controls when the Ribbon changes its color scheme. Inherited from TdxCustomRibbon.
ColorSchemeNameSpecifies the name of the active built-in or common skin applied to the Ribbon control. Inherited from TdxCustomRibbon.
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
ConstraintsInherited from TControl.
ContextsProvides access to the Ribbon’s collection of application contexts. Inherited from TdxCustomRibbon.
ControlCountInherited from TWinControl.
ControlsInherited from TWinControl.
ControlStateInherited from TControl.
ControlStyleInherited from TControl.
Ctl3DInherited from TWinControl.
CurrentPPIInherited from TControl.
CursorInherited from TControl.
CustomHintInherited from TControl.
DefaultFormIconPlaceholderWidthSpecifies the pixel width of the area allocated for the application icon when it is hidden. This setting affects all Ribbon controls in the application. Inherited from TdxCustomRibbon.
DefaultUseGlobalSkinSpecifies if all Ribbon controls in the application automatically update their appearance from application-wide skin and palette settings. Inherited from TdxCustomRibbon.
DesignInfoInherited from TComponent.
DockClientCountInherited from TWinControl.
DockClientsInherited from TWinControl.
DockManagerInherited from TWinControl.
DockOrientationInherited from TControl.
DockSiteInherited from TWinControl.
DocumentNameSpecifies the display name of the currently active document. Inherited from TdxCustomRibbon.
DoubleBufferedInherited from TWinControl.
DragAndDropObjectInherited from TcxControl.
DragAndDropObjectClassInherited from TcxControl.
DragAndDropStateInherited from TcxControl.
DragCursorInherited from TControl.
DragKindInherited from TControl.
DragModeInherited from TControl.
EnabledInherited from TControl.
EnableTabAeroSpecifies if form transparency is enabled. Inherited from TdxCustomRibbon.
ExplicitHeightInherited from TControl.
ExplicitLeftInherited from TControl.
ExplicitTopInherited from TControl.
ExplicitWidthInherited from TControl.
FloatingInherited from TControl.
FloatingDockSiteClassInherited from TControl.
FocusOnClick protectedSpecifies if clicking the control focuses it. Inherited from TcxControl.
FontInherited from TControl.
FontsSpecifies font options for Ribbon elements. Inherited from TdxCustomRibbon.
FormIconPlaceholderWidthSpecifies the pixel width of the area allocated for the application icon when it is hidden. Inherited from TdxCustomRibbon.
HandleInherited from TWinControl.
HeightInherited from TControl.
HelpButtonSpecifies the Ribbon Help Button. Inherited from TdxCustomRibbon.
HelpButtonScreenTipSpecifies a ScreenTip for the Ribbon Help Button. Inherited from TdxCustomRibbon.
HelpContextInherited from TControl.
HelpKeywordInherited from TControl.
HelpTypeInherited from TControl.
HiddenGets whether the Ribbon is hidden. Inherited from TdxCustomRibbon.
HintSpecifies a hint message for the control. Inherited from TcxControl.
HostDockSiteInherited from TControl.
HScrollBar protectedInherited from TcxControl.
HScrollBarVisible protectedInherited from TcxControl.
ImeModeInherited from TWinControl.
ImeNameInherited from TWinControl.
IsDesigningIdentifies if the control is being modified by the form designer. Inherited from TcxControl.
IsDestroyingIdentifies if the control is about to be destroyed. Inherited from TcxCustomControl.
IsDrawingLockedInherited from TWinControl.
IsFocusedIdentifies if the control has focus. Inherited from TcxControl.
IsLoadingIdentifies if the control is being loaded. Inherited from TcxControl.
IsPopupGroupsModeInherited from TdxCustomRibbon.
Keys protectedInherited from TcxControl.
LayoutSpecifies the active layout type of the Ribbon UI if a supported Ribbon UI Style is active. Inherited from TdxCustomRibbon.
LeftInherited from TControl.
LockCountInherited from TdxCustomRibbon.
LookAndFeel protectedProvides access to the control’s look & feel settings. Inherited from TcxControl.
LookAndFeelPainter protectedInherited from TcxControl.
LRDockWidthInherited from TControl.
MarginsInherited from TControl.
MinimizeOnTabDblClickSpecifies whether the Ribbon can be minimized on a Ribbon Tab double-click. Inherited from TdxCustomRibbon.
MouseCaptureInherited from TControl.
MouseCaptureObjectProvides access to the dragged object during a drag-and-drop operation. Inherited from TcxControl.
MouseDownPosSpecifies the mouse pointer position when an OnMouseDown event occurs. Inherited from TcxControl.
MouseInClientInherited from TWinControl.
NameInherited from TComponent.
ObserversInherited from TComponent.
OptionsFadingProvides access to the fading animation settings of the Ribbon control’s elements. Inherited from TdxCustomRibbon.
OwnerInherited from TComponent.
PaddingInherited from TWinControl.
ParentInherited from TControl.
ParentBackground protectedInherited from TcxControl.
ParentBiDiModeInherited from TControl.
ParentColorInherited from TControl.
ParentCtl3DInherited from TWinControl.
ParentCustomHintInherited from TControl.
ParentDoubleBufferedInherited from TWinControl.
ParentFontInherited from TControl.
ParentShowHintInherited from TControl.
ParentWindowInherited from TWinControl.
PixelsPerInchInherited from TWinControl.
PopupMenu protectedSpecifies the popup menu associated with the control. Inherited from TcxControl.
PopupMenuItemsSpecifies menu item groups to be shown in the Ribbon context menu. Inherited from TdxCustomRibbon.
QuickAccessToolbarProvides access to the Ribbon Quick Access Toolbar’s settings. Inherited from TdxCustomRibbon.
RaiseOnNonMainThreadUsageInherited from TControl.
RedrawDisabledInherited from TWinControl.
ScaleFactorInherited from TControl.
ScrollBars protectedInherited from TcxControl.
ShowFormIconSpecifies if the application icon is visible. Inherited from TdxCustomRibbon.
ShowHintInherited from TControl.
ShowingInherited from TWinControl.
ShowMinimizeButtonSwitches the visibility of the Minimize button on the Ribbon’s right side. Inherited from TdxCustomRibbon.
ShowTabGroupsSpecifies whether tabbed pages are shown in the Ribbon. Inherited from TdxCustomRibbon.
ShowTabHeadersSpecifies whether tab headers are shown in the Ribbon. Inherited from TdxCustomRibbon.
StyleSpecifies the Ribbon UI style. Inherited from TdxCustomRibbon.
StyleElementsInherited from TControl.
StyleNameInherited from TControl.
SupportNonClientDrawingSpecifies if the Ribbon control decorates non-client areas of the parent form. Inherited from TdxCustomRibbon.
TabAreaSearchToolbarProvides access to the settings of the search toolbar displayed in the tab area of the Ribbon control. Inherited from TdxCustomRibbon.
TabAreaToolbarProvides access to the Ribbon Tab Area Toolbar‘s settings. Inherited from TdxCustomRibbon.
TabCountGets a count of Ribbon tabs. Inherited from TdxCustomRibbon.
TabOrderInherited from TWinControl.
TabsProvides access to a collection of Ribbon tabs. Inherited from TdxCustomRibbon.
TabStopInherited from TcxControl.
TagInherited from TComponent.
TBDockHeightInherited from TControl.
TextInherited from TControl.
TipModeInherited from TWinControl.
TopInherited from TControl.
TouchInherited from TControl.
Transparent protectedSpecifies if the control is transparent in GDI render mode. Inherited from TcxControl.
UndockHeightInherited from TControl.
UndockWidthInherited from TControl.
UseDockManagerInherited from TWinControl.
UseGlobalSkinSpecifies if the Ribbon control automatically updates its appearance from the skin and palette defined application-wide. Inherited from TdxCustomRibbon.
VCLComObjectInherited from TComponent.
VisibleInherited from TControl.
VisibleDockClientCountInherited from TWinControl.
VisibleTabCountGets a count of Ribbon tabs that are visible in the Ribbon. Inherited from TdxCustomRibbon.
VisibleTabsProvides indexed access to the visible Ribbon tab at the position specified by the zero-based Index parameter. Inherited from TdxCustomRibbon.
VScrollBar protectedInherited from TcxControl.
VScrollBarVisible protectedInherited from TcxControl.
WidthInherited from TControl.
WindowProcInherited from TControl.

Methods

NameDescription
AcceptMousePosForClick(Integer,Integer)Inherited from TcxControl.
AddFontListener(IcxFontListener)Inherited from TcxControl.
AddListener(IdxRibbonListener)Inherited from TdxCustomRibbon.
ApplicationMenuPopupInvokes the Ribbon Application Menu. Inherited from TdxCustomRibbon.
AreGroupsVisibleInherited from TdxCustomRibbon.
Assign(TPersistent)Inherited from TPersistent.
AssignTo(TPersistent)Inherited from TPersistent.
BeginDrag(Boolean,Integer)Inherited from TControl.
BeginDragAndDropInherited 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.
BeginUpdatePostpones all Ribbon UI redraw operations that reflect any content or appearance change until an EndUpdate procedure call. Inherited from TdxCustomRibbon.
BringToFrontInherited from TControl.
Broadcast(Untyped)Inherited from TWinControl.
CanFocusInherited from TWinControl.
CanFocusExInherited from TcxControl.
ChangeScale(Integer,Integer)Inherited from TControl.
CheckHideRecalculates the Ribbon UI layout when the parent form’s height changes. Inherited from TdxCustomRibbon.
CheckNonMainThreadUsageInherited from TControl.
ClickInherited from TControl.
ClientToParent(TPoint,TWinControl)Inherited from TControl.
ClientToScreen(TPoint)Inherited from TControl.
ClientToScreen(TRect)Inherited from TControl.
CloseTabGroupsPopupWindowInherited from TdxCustomRibbon.
ConstrainedResize(Integer,Integer,Integer,Integer)Inherited from TControl.
ContainsControl(TControl)Inherited from TWinControl.
ContainsToolBar(TdxBar)Inherited from TdxCustomRibbon.
ControlAtPos(TPoint,Boolean,Boolean,Boolean)Inherited from TWinControl.
CreateParentedControl(HWND)Inherited from TWinControl.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
DisableAlignInherited from TWinControl.
Dock(TWinControl,TRect)Inherited from TControl.
DockDrop(TDragDockObject,Integer,Integer)Inherited from TWinControl.
DragDrop(TObject,Integer,Integer)Inherited from TControl.
DraggingInherited from TControl.
DrawTextBiDiModeFlags(Longint)Inherited from TControl.
DrawTextBiDiModeFlagsReadingOnlyInherited from TControl.
EnableAlignInherited from TWinControl.
EndDrag(Boolean)Inherited from TControl.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
EndUpdateApplies all pending changes and redraws the Ribbon control after a BeginUpdate procedure call. Inherited from TdxCustomRibbon.
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.
FocusedInherited from TWinControl.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetControlsAlignmentInherited from TControl.
GetDragImagesInherited from TControl.
GetHashCodeInherited from TObject.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
GetStyleNameInherited from TControl.
GetSystemMetrics(Integer)Inherited from TControl.
GetTabAtPos(Integer,Integer)Returns the Ribbon tab by its relative screen coordinates. Inherited from TdxCustomRibbon.
GetTabControlList(TList)Inherited from TWinControl.
GetTabOrderList(TList)Inherited from TWinControl.
GetTextBuf(PChar,Integer)Inherited from TControl.
GetTextLenInherited from TControl.
HandleAllocatedInherited from TWinControl.
HandleNeededInherited from TWinControl.
HasParentInherited from TComponent.
HideInherited from TControl.
InitiateActionInherited from TControl.
InsertComponent(TComponent)Inherited from TComponent.
InsertControl(TControl)Inherited from TWinControl.
InvalidateInherited 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)Inherited from TdxCustomRibbon.
InvalidateRgn(TcxRegion,Boolean)Inherited from TcxControl.
InvalidateWithChildrenInherited from TcxControl.
IsCustomStyleActiveInherited from TControl.
IsImplementorOf(IInterface)Inherited from TComponent.
IsLightStyleColor(TColor)Inherited from TControl.
IsMergedInherited from TdxCustomRibbon.
IsMouseInPressedArea(Integer,Integer)Inherited from TcxControl.
IsRightToLeftInherited from TControl.
LoadedInherited from TComponent.
LockDrawingInherited from TWinControl.
LockScrollBarsInherited from TcxControl.
ManualDock(TWinControl,TControl,TAlign)Inherited from TControl.
ManualFloat(TRect)Inherited from TControl.
Merge(TdxCustomRibbon,TdxRibbonMergeOptions)Inherited from TdxCustomRibbon.
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.
PostMouseMoveInherited from TcxControl.
PostMouseMove(TPoint)Inherited from TcxControl.
PreProcessMessage(TMsg)Inherited from TWinControl.
RealignInherited from TWinControl.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RefreshInherited from TControl.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveControl(TControl)Inherited from TWinControl.
RemoveFontListener(IcxFontListener)Inherited from TcxControl.
RemoveFreeNotification(TComponent)Inherited from TComponent.
RemoveListener(IdxRibbonListener)Inherited from TdxCustomRibbon.
RepaintInherited 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.
SendToBackInherited from TControl.
SetBounds(Integer,Integer,Integer,Integer)Inherited from TControl.
SetDesignVisible(Boolean)Inherited from TControl.
SetFocusInherited 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.
ShowInherited from TControl.
ShowCustomizationForm(TdxRibbonCustomizationFormMode)Inherited from TdxCustomRibbon.
ShowTabGroupsPopupWindowRenders a tab page as a drop-down window. Inherited from TdxCustomRibbon.
StartDrag(TDragObject)Inherited from TcxControl.
SupportsUIAutomation protectedInherited from TcxCustomControl.
SystemInfoChanged(Cardinal)Inherited from TcxControl.
ToStringInherited from TObject.
TranslationChangedInherited from TcxControl.
UnlockDrawingInherited from TWinControl.
UnlockScrollBarsInherited from TcxControl.
Unmerge(TdxCustomRibbon)Inherited from TdxCustomRibbon.
UpdateInherited from TControl.
UpdateAction(TBasicAction)Inherited from TComponent.
UpdateControlStateInherited from TWinControl.
UpdateWithChildrenInherited from TcxControl.
UseRightToLeftAlignmentInherited from TControl.
UseRightToLeftReadingInherited from TControl.
UseRightToLeftScrollBarInherited from TControl.
WndProc(TMessage)Inherited from TControl.

Events

NameDescription
OnAlignInsertBeforeInherited from TWinControl.
OnAlignPositionInherited from TWinControl.
OnApplicationMenuClickFires when the Ribbon Application Menu is about to be displayed on-screen. Inherited from TdxCustomRibbon.
OnCanResizeInherited from TControl.
OnClickInherited from TControl.
OnConstrainedResizeInherited from TControl.
OnContextPopupInherited from TControl.
OnDblClickInherited from TControl.
OnDockDropInherited from TWinControl.
OnDockOverInherited from TWinControl.
OnDragDropInherited from TControl.
OnDragOverInherited from TControl.
OnEndDockInherited from TControl.
OnEndDragInherited from TControl.
OnEnterInherited from TWinControl.
OnExitInherited from TWinControl.
OnFocusChanged protectedInherited from TcxControl.
OnGestureInherited from TControl.
OnGetSiteInfoInherited from TWinControl.
OnHelpButtonClickFires after the Ribbon Help Button has been clicked. Inherited from TdxCustomRibbon.
OnHideMinimizedByClickEnables you to provide custom processing for mouse clicks that result in hiding a minimized Ribbon. Inherited from TdxCustomRibbon.
OnKeyDownInherited from TWinControl.
OnKeyPressInherited from TWinControl.
OnKeyUpInherited from TWinControl.
OnMinimizedChangedEnables you to respond to Ribbon minimization or restoration. Inherited from TdxCustomRibbon.
OnMoreCommandsExecuteFires after the More Commands… item in the Ribbon Quick Access Toolbar‘s dropdown menu has been clicked. Inherited from TdxCustomRibbon.
OnMouseActivateInherited from TControl.
OnMouseDownInherited from TControl.
OnMouseEnterOccurs when the mouse pointer enters into the control. Inherited from TcxControl.
OnMouseLeaveOccurs when the mouse pointer leaves the control. Inherited from TcxControl.
OnMouseMoveInherited from TControl.
OnMouseUpInherited from TControl.
OnMouseWheelInherited from TControl.
OnMouseWheelDownInherited from TControl.
OnMouseWheelUpInherited from TControl.
OnResizeInherited from TControl.
OnStartDockInherited from TControl.
OnStartDragInherited from TControl.
OnTabChangedFires after an active Ribbon tab has been changed. Inherited from TdxCustomRibbon.
OnTabChangingFires when an active Ribbon tab is about to be changed. Inherited from TdxCustomRibbon.
OnTabGroupCollapsedFires after the AGroup has been collapsed within the Ribbon tab passed as the ATab parameter. Inherited from TdxCustomRibbon.
OnTabGroupExpandedFires after the AGroup has been expanded within the Ribbon tab passed as the ATab parameter. Inherited from TdxCustomRibbon.
OnUnDockInherited from TWinControl.

See Also

TdxRibbon Class

dxRibbon Unit