OfficeNavigationBar.RegisterItem Event

Fires when an item is automatically added that corresponds to an element in the element source provided by the OfficeNavigationBar.NavigationClient. This event allows you to customize these automatically created items.

Namespace: DevExpress.XtraBars.Navigation

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Navigation Client")]
public event NavigationBarNavigationClientItemEventHandler RegisterItem

VB.NET

<DXCategory("Navigation Client")>
Public Event RegisterItem As NavigationBarNavigationClientItemEventHandler

Event Data

The RegisterItem event's data class is DevExpress.XtraBars.Navigation.NavigationBarNavigationClientItemEventArgs.

Remarks

When you set the OfficeNavigationBar.NavigationClient property to an INavigationBarClient object, for each element in the INavigationBarClient.ItemsSource list, a ClientNavigationBarItem is automatically added to the OfficeNavigationBar.Items collection. For these items, the RegisterItem event fires allowing you to perform additional item customization.

When the OfficeNavigationBar.NavigationClient property is cleared, the automatically created items are removed from the OfficeNavigationBar.Items collection and the OfficeNavigationBar.UnregisterItem event fires for each of them.

Currently, the INavigationBarClient interface is implemented by the NavBarControl. The NavBarControl’s INavigationBarClient.ItemsSource property returns a collection of NavBarGroups, specified by the NavBarControl.Groups property.