TdxCustomNavBar Members
The TdxNavBar control’s base class.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. |
| ActiveGroup | Specifies the active group in the NavBar control. |
| ActiveGroupIndex | Specifies the index of the active group in the NavBar control. |
| Align | Inherited from TControl. |
| AlignDisabled | Inherited from TWinControl. |
| AlignWithMargins | Inherited from TControl. |
| AllowSelectLinks | Deprecated. This property exists for backward compatibility only. Use the OptionsBehavior.Common.AllowSelectLinks property instead. |
| Anchors | Inherited from TControl. |
| AutoSize | Inherited from TControl. |
| 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 | Specifies the NavBar control’s border style. |
| 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. |
| Caption | Inherited from TControl. |
| 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. |
| 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. |
| 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. |
| Cursors | Provides access to mouse pointer images for the current NavBar control. |
| CustomHint | Inherited from TControl. |
| Customization | Specifies Customization Form settings. |
| DefaultStyles | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.DefaultStyles property instead. |
| DefaultUseGlobalSkin | Specifies if all Navigation Bar controls in the application automatically update their appearance from application-wide skin and palette settings. |
| DesignInfo | Inherited from TComponent. |
| DockClientCount | Inherited from TWinControl. |
| DockClients | Inherited from TWinControl. |
| DockManager | Inherited from TWinControl. |
| DockOrientation | Inherited from TControl. |
| DockSite | Inherited from TWinControl. |
| DoubleBuffered | Inherited from TWinControl. |
| DragAndDropObject | Inherited from TcxControl. |
| DragAndDropObjectClass | Inherited from TcxControl. |
| DragAndDropState | Inherited from TcxControl. |
| DragCopyCursor | Deprecated. This property exists for backward compatibility only. Use the Cursors.DragCopyCursor property instead. |
| DragCursor | Inherited from TControl. |
| DragDropFlags | Deprecated. This property exists for backward compatibility only. Use the OptionsBehavior.Common.DragDropFlags property instead. |
| DragKind | Inherited from TControl. |
| DragMode | Inherited from TControl. |
| EachGroupHasSelectedLink | Deprecated. This property exists for backward compatibility only. Use the OptionsBehavior.Common.EachGroupHasSelectedLink property instead. |
| Enabled | Inherited from TControl. |
| EnableDragging | Specifies whether dragging is enabled in the NavBar control. |
| 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. |
| Groups | Provides access to the collection of groups in the NavBar control. |
| Handle | Inherited from TWinControl. |
| Height | Inherited from TControl. |
| HelpContext | Inherited from TControl. |
| HelpKeyword | Inherited from TControl. |
| HelpType | Inherited from TControl. |
| Hint | Specifies a hint message for the control. Inherited from TcxControl. |
| HostDockSite | Inherited from TControl. |
| HotTrackedGroup | |
| HotTrackedGroupCursor | Deprecated. This property exists for backward compatibility only. Use the Cursor.HotTrackedGroupCursor property instead. |
| HotTrackedLink | Provides access to the NavBar link which is being hot-tracked at the moment. |
| HotTrackedLinkCursor | Deprecated. This property exists for backward compatibility only. Use the Cursors.HotTrackedLinkCursor property instead. |
| 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. |
| Items | Provides access to the list of items in the NavBar control. |
| Keys protected | Inherited from TcxControl. |
| LargeImages | Deprecated. This property exists for backward compatibility only. Use the OptionsImage.LargeImages property instead. |
| Left | Inherited from TControl. |
| LookAndFeel protected | Provides access to the control’s look & feel settings. Inherited from TcxControl. |
| LookAndFeelPainter protected | Inherited from TcxControl. |
| LookAndFeelSchemes | |
| LRDockWidth | Inherited from TControl. |
| Margins | Inherited from TControl. |
| 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. |
| NavigationPaneMaxVisibleGroups | Deprecated. This property exists for backward compatibility only. Use the OptionsView.NavigationPane.MaxVisibleGroups property instead. |
| NavigationPaneOverflowPanelItemCount | Gets the number of icons displayed within the overflow panel. |
| NavigationPaneOverflowPanelUseSmallImages | Deprecated. This property exists for backward compatibility only. Use the OptionsView.NavigationPane.OverflowPanelUseSmallImages property instead. |
| Observers | Inherited from TComponent. |
| OptionsBehavior | Provides access to settings that determine the NavBar control’s response to end-user actions. |
| OptionsImage | Provides access to item and group image options defined with the current NavBar control. |
| OptionsStyle | Provides access to a set of styles that control the appearance of the NavBar control’s elements. |
| OptionsView | Provides access to settings that determine appearance aspects of the NavBar control. |
| Owner | Inherited from TComponent. |
| Padding | Inherited from TWinControl. |
| Painter | Gets an object implementing the painting functionality of the NavBar control. |
| 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 | Specifies the popup menu associated with the control. Inherited from TcxControl. |
| PressedGroup | Gets the group whose header is currently pressed. |
| PressedLink | Gets the currently pressed link. |
| RaiseOnNonMainThreadUsage | Inherited from TControl. |
| RedrawDisabled | Inherited from TWinControl. |
| RootGroupCount | |
| RootGroups | |
| ScaleFactor | Inherited from TControl. |
| ScrollBar | |
| ScrollBars protected | Inherited from TcxControl. |
| ScrollButtonDownIsDown | |
| ScrollButtonUpIsDown | |
| ScrollPosition | Gets an integer value which represents the current position of the scrollbar. |
| ShowGroupCaptions | Deprecated. This property exists for backward compatibility only. Use the OptionsView.Common.ShowGroupCaptions property instead. |
| ShowGroupsHint | Deprecated. This property exists for backward compatibility only. Use the OptionsBehavior.Common.ShowGroupHint property instead. |
| ShowHint | Inherited from TControl. |
| Showing | Inherited from TWinControl. |
| ShowLinksHint | Deprecated. This property exists for backward compatibility only. Use the OptionsBehavior.Common.ShowLinksHint property instead. |
| ShowNavigationPaneOverflowPanelHints | Deprecated. This property exists for backward compatibility only. Use the OptionsBehavior.NavigationPane.ShowLinksHint property instead. |
| ShowSpecialGroup | Deprecated. This property exists for backward compatibility only. Use the OptionsView.ExplorerBar.ShowSpecialGroup property instead. |
| SmallImages | Deprecated. This property exists for backward compatibility only. Use the OptionsImage.SmallImages property instead. |
| SourceGroup | Gets the NavBar group which is being dragged at the moment. |
| SourceItem | Gets the NavBar item whose corresponding link is being dragged at the moment. |
| SourceLink | Gets the NavBar link which is being dragged at the moment. |
| SourcePoint | Gets the point at which the current drag & drop operation has been initiated. |
| SpaceBetweenGroups | Deprecated. This property exists for backward compatibility only. Use the OptionsView.ExplorerBar.SpaceBetweenGroups property instead. |
| StyleBackground | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyles.Background property instead. |
| StyleButton | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyles.Button property. |
| StyleButtonHotTracked | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyles.ButtonHotTracked property instead. |
| StyleButtonPressed | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyles.ButtonPressed property instead. |
| StyleDropTargetGroup | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyles.DropTargetGroup property instead. |
| StyleDropTargetLink | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyles.DropTargetLink property instead. |
| StyleElements | Inherited from TControl. |
| StyleHint | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyles.Hint property instead. |
| StyleName | Inherited from TControl. |
| StyleNavigationPaneHeader | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyles.NavigationPaneHeader property instead. |
| Styles | Deprecated. This property exists for backward compatibility only. Use the OptionsStyle.CustomStyleRepository property instead. |
| TabOrder | Inherited from TWinControl. |
| TabStop | Inherited from TcxControl. |
| Tag | Inherited from TComponent. |
| TargetGroup | Represents a target group in drag & drop operations. |
| TargetPoint | Gets the current mouse pointer coordinates relative to the top-left corner of the control. |
| TargetPosition | |
| 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. |
| VCLComObject | Inherited from TComponent. |
| View | Specifies the View currently applied to the control. |
| ViewInfo | Provides access to ViewInfo information of the entire NavBar control. |
| ViewReal | |
| ViewStyle | Provides access to a painter that is used for the currently applied View. |
| Visible | Inherited from TControl. |
| VisibleDockClientCount | Inherited from TWinControl. |
| VisibleGroupCount | Gets the number of groups that are visible in the NavBar control. |
| VScrollBar protected | Inherited from TcxControl. |
| VScrollBarVisible protected | Inherited from TcxControl. |
| Width | Inherited from TControl. |
| WindowProc | Inherited from TControl. |
Methods
Events
| Name | Description |
|---|---|
| OnActiveGroupChanged | Fires after the active group has been changed. |
| OnActiveGroupChanging | Enables you to prohibit a group from being activated. |
| OnAlignInsertBefore | Inherited from TWinControl. |
| OnAlignPosition | Inherited from TWinControl. |
| OnCalcGroupClientHeight | Enables you to calculate custom height for groups’ client areas. |
| OnCalcGroupHintRect | Enables you to assign custom sizes for hints displayed for NavBar groups. |
| OnCalcLinkHintRect | Occurs when a particular NavBar link hint rectangular dimensions are recalculated. |
| OnCalcNavigationPaneOverflowPanelHintRect | Enables you to calculate hint rectangles for icons displayed within the overflow panel. |
| OnCanResize | Inherited from TControl. |
| OnClick | Inherited from TControl. |
| OnCollapsed protected | Enables you to execute custom code when the NavBar control has been collapsed. |
| OnConstrainedResize | Inherited from TControl. |
| OnContextPopup | Inherited from TControl. |
| OnCustomDraw | Provides access to events that allow you to custom paint NavBar elements. |
| OnCustomDrawBackground | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.Background event instead. |
| OnCustomDrawBottomScrollButton | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.ButtonScrollButton event. |
| OnCustomDrawGroupCaption | Deprecated. This property exists for backward compatibility only. Handle the OnCustomDraw.GroupCaption event instead. |
| OnCustomDrawGroupClientBackground | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.GroupClientBackground event instead. |
| OnCustomDrawGroupClientForeground | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.GroupClientForeground event instead. |
| OnCustomDrawGroupHint | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.GroupHint event instead. |
| OnCustomDrawLink | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.Link event instead. |
| OnCustomDrawLinkHint | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.LinkHint event instead. |
| OnCustomDrawNavigationPaneHeader | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.NavigationPaneHeader event instead. |
| OnCustomDrawNavigationPaneOverflowPanel | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.NavigationPaneOverflowPanel event instead. |
| OnCustomDrawNavigationPaneOverflowPanelHint | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.NavigationPaneOverflowPanelHint event instead. |
| OnCustomDrawNavigationPaneSplitter | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.NavigationPaneSplitter event instead. |
| OnCustomDrawTopScrollButton | Deprecated. This event exists for backward compatibility only. Handle the OnCustomDraw.TopScrollButton event instead. |
| 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. |
| OnExpanded protected | Enables you to execute custom code when the NavBar control has been expanded. |
| OnFocusChanged protected | Inherited from TcxControl. |
| OnGesture | Inherited from TControl. |
| OnGetGroupHint | Enables you to override or hide hints displayed for NavBar groups. |
| OnGetLinkHint | Enables you to override or hide hints displayed for NavBar links. |
| OnGetOverlaySize protected | Enables you to adjust the expanded Hamburger Menu’s dimensions in minimal overlay mode. |
| OnGetSiteInfo | Inherited from TWinControl. |
| OnGroupClick | Fires when a NavBar group is clicked. |
| OnGroupHotTrack | Fires when the mouse cursor pauses over a NavBar group. |
| OnGroupPress | Fires when a NavBar group is pressed. |
| OnKeyDown | Inherited from TWinControl. |
| OnKeyPress | Inherited from TWinControl. |
| OnKeyUp | Inherited from TWinControl. |
| OnLinkClick | Fires when a NavBar link is clicked. |
| OnLinkHotTrack | Fires when the mouse cursor pauses over a NavBar link. |
| OnLinkPress | Fires when a NavBar link is pressed. |
| 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. |
| OnNavigationPaneCollapsed | Enables you to execute custom code when the Navigation Pane has been collapsed. |
| OnNavigationPaneExpanded | Enables you to execute custom code when the Navigation Pane has been expanded. |
| OnNavigationPanePopupShowed protected | Enables you to execute custom code when the active group‘s content has been displayed in a popup window for the collapsed Navigation Pane. |
| OnNavigationPanePopupShowing protected | Enables you to prevent the active group‘s popup window from appearing for the collapsed Navigation Pane. |
| OnOverlayShowed protected | Enables you to execute custom code when the Hamburger Menu expands on top of the control’s parent (container) as an overlay. |
| OnOverlayShowing protected | Enables you to prevent the Hamburger Menu from expanding on top of the control’s parent (container) as an overlay. |
| OnPopupShowed protected | Enables you to execute custom code when the active group‘s content has been displayed in a popup window for the collapsed NavBar control. |
| OnPopupShowing protected | Enables you to prevent the collapsed NavBar control from displaying a popup window with the active group‘s content. |
| OnResize | Inherited from TControl. |
| OnStartDock | Inherited from TControl. |
| OnStartDrag | Inherited from TControl. |
| OnUnDock | Inherited from TWinControl. |
See Also