Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

TdxNavBarGroup Members

A group in a NavBar control.

#Constructors
Show Inherited Hide Inherited

Name Description
Create(TComponent) Inherited from TComponent.

#Properties
Show Inherited Hide Inherited

Name Description
Align Specifies the current group’s vertical alignment within Explorer Bar Views.
Automation Provides access to the navigation bar item’s UI automation and accessibility settings. Inherited from TdxNavBarCustomItem.
Caption Specifies a collection item’s caption. Inherited from TdxNavBarCustomItem.
ChildCount
Children
Collection Provides access to the collection to which the current item belongs. Inherited from TdxNavBarComponentCollectionItem.
ComObject Inherited from TComponent.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
Control Provides access to the control used as the container for custom controls within the current group.
CustomStyles Provides access to custom styles of the current group.
DesignInfo Inherited from TComponent.
DisplayName Specifies the collection item’s name displayed in the collection editor. Inherited from TcxComponentCollectionItem.
Expandable Deprecated. This property exists for backward compatibility only. Use the OptionsExpansion.Expandable property instead.
Expanded Deprecated. This property exists for backward compatibility only. Use the OptionsExpansion.Expanded property instead.
Hint Specifies a collection item’s hint text. Inherited from TdxNavBarCustomItem.
ID Gets the unique identifier of the current collection element. Inherited from TcxComponentCollectionItem.
Index Specifies the zero-based index of the current element in the collection. Inherited from TcxComponentCollectionItem.
LargeImageIndex Specifies a collection item’s large image. Inherited from TdxNavBarCustomItem.
Level
LinkCount Returns the total number of links owned by the current group.
Links Returns a link by its index.
LinksUseSmallImages Specifies whether links of a group use small or large images.
Name Inherited from TComponent.
Observers Inherited from TComponent.
OptionsExpansion Provides access to a set of options that allow you to change the expanded state of the current group, and customize its appearance in this state.
OptionsGroupControl Provides access to appearance and behavior options of the current group’s client area.
Owner Inherited from TComponent.
Parent Provides access to the group to which the current group belongs.
Position
SelectedLink Provides access to a group’s selected link.
SelectedLinkIndex Specifies the index of a group’s selected link.
ShowAsIconView Specifies whether links are displayed as a set of icons.
ShowCaption Specifies the group header’s visibility.
ShowControl Deprecated. This property exists for backward compatibility only. Use the OptionsGroupControl.ShowControl property instead.
ShowExpandButton Deprecated. This property exists for backward compatibility only. Use the OptionsExpansion.ShowExpandButton property instead.
SmallImageIndex Specifies a collection item’s small image. Inherited from TdxNavBarCustomItem.
StyleBackground Deprecated. This property exists for backward compatibility only. Use the CustomStyles.Background property instead.
StyleControl Deprecated. This property exists for backward compatibility only. Use the CustomStyles.Control property instead.
StyleHeader Deprecated. This property exists for backward compatibility only. Use the CustomStyles.Header property instead.
StyleHeaderActive Deprecated. This property exists for backward compatibility only. Use the CustomStyles.HeaderActive property instead.
StyleHeaderActiveHotTracked Deprecated. This property exists for backward compatibility only. Use the CustomStyles.HeaderActiveHotTracked property instead.
StyleHeaderActivePressed Deprecated. This property exists for backward compatibility only. Use the CustomStyles.HeaderActivePressed property instead.
StyleHeaderHotTracked Deprecated. This property exists for backward compatibility only. Use the CustomStyles.HeaderHotTracked property instead.
StyleHeaderPressed Deprecated. This property exists for backward compatibility only. Use the CustomStyles.HeaderPressed property instead.
Tag Inherited from TComponent.
TopVisibleLinkIndex Specifies the index of the link displayed at the top of the current group.
UseControl Deprecated. This property exists for backward compatibility only. Use the OptionsGroupControl.UseControl property instead.
UseRestSpace Specifies whether the current group occupies a NavBar control’s space that is free of other groups.
UseSmallImages Specifies whether a large or small image is displayed within a group header.
VCLComObject Inherited from TComponent.
Visible Specifies the visibility of a collection item. Inherited from TdxNavBarCustomItem.
VisibleForCustomization Specifies whether end-users can change the current group’s visibility via the Navigation Pane’s context menu.

#Methods
Show Inherited Hide Inherited

Name Description
AcceptControl(TdxNavBarGroupControl)
AddToCollection(TcxComponentCollection) protected Adds the current collection element to a collection. Inherited from TcxComponentCollectionItem.
Assign(TPersistent) Inherited from TPersistent.
AssignTo(TPersistent) Inherited from TPersistent.
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.
CheckSiblingGroups
ClearLinks Clears the group’s link collection.
CreateLink(TdxNavBarItem) Creates a link to a specific item within the current group.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
Equals(TObject) Inherited from TObject.
ExecuteAction(TBasicAction) Inherited from TComponent.
FindComponent(String) Inherited from TComponent.
FindLink(TdxNavBarItem) Searches the current group for a link to a specified item.
FreeNotification(TComponent) Inherited from TComponent.
FreeOnRelease Inherited from TComponent.
GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
GetCollectionFromParent(TComponent) Inherited from TcxComponentCollectionItem.
GetHashCode Inherited from TObject.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
GetParentComponent Returns the parent component of the current item’s collection. Inherited from TcxComponentCollectionItem.
HasAsChild(TdxNavBarGroup,Boolean)
HasParent Inherited from TComponent.
InsertComponent(TComponent) Inherited from TComponent.
InsertLink(TdxNavBarItem,Integer)
IsDestroying Inherited from TdxNavBarCustomItem.
IsImplementorOf(IInterface) Inherited from TComponent.
IsLoading Inherited from TdxNavBarCustomItem.
Loaded Inherited from TComponent.
LoadFromIniFile(TCustomIniFile,string,Boolean)
MoveLink(TdxNavBarItemLink,Integer)
MoveTo(TdxNavBarGroup,Integer) Moves the group to a specific location within the group hierarchy.
Notification(TComponent,TOperation) Inherited from TComponent.
ReferenceInterface(IInterface,TOperation) Inherited from TComponent.
ReleaseControl
RemoveComponent(TComponent) Inherited from TComponent.
RemoveFreeNotification(TComponent) Inherited from TComponent.
RemoveFromCollection(TcxComponentCollection) protected Removes the current collection element from a collection. Inherited from TcxComponentCollectionItem.
RemoveLink(TdxNavBarItemLink) Removes the link specified by its index from a group.
RemoveLink(Integer)
RemoveLinks(TdxNavBarItem) Removes the links corresponding to the specified item.
SaveToIniFile(TCustomIniFile,string,Boolean)
SetParentComponent(TComponent) Adds the current element to a collection associated with a specified component. Inherited from TcxComponentCollectionItem.
SetSubComponent(Boolean) Inherited from TComponent.
ToString Inherited from TObject.
UpdateAction(TBasicAction) Inherited from TComponent.

#Events
Show Inherited Hide Inherited

Name Description
OnClick Occurs immediately after a group or link has been clicked. Inherited from TdxNavBarCustomItem.
OnCollapsed Occurs after a group has been collapsed.
OnExpanded Occurs after a group has been expanded.
OnSelectedLinkChanged Occurs immediately after a link has been selected within a group.
OnTopVisibleLinkChanged Occurs after the top visible link has been changed within a group.
See Also