ShowNavigationItemController.CustomShowNavigationItem Event

Occurs when an end-user clicks a navigation item in the navigation control.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<CustomShowNavigationItemEventArgs> CustomShowNavigationItem

VB.NET

Public Event CustomShowNavigationItem As EventHandler(Of CustomShowNavigationItemEventArgs)

Event Data

The CustomShowNavigationItem event's data class is CustomShowNavigationItemEventArgs. The following properties provide information specific to this event:

Property	Description
ActionArguments	Represents arguments passed to the navigation Action’s SingleChoiceAction.Execute event.
Handled	Gets or sets a value that indicates whether the event handler has completely handled the event or whether the system should continue its own processing. Inherited from HandledEventArgs.

Remarks

This event is raised as a result of calling the ShowNavigationItem method, which serves as the Navigation Action’s SingleChoiceAction.Execute event handler. If you need to show a custom View or a separate form, handle this event. Use the handler’s CustomShowNavigationItemEventArgs.ActionArguments.SelectedChoiceActionItem parameter, to get the clicked item. Set the handler’s CustomShowNavigationItemEventArgs.Handled parameter to true to avoid display of the default View set for the clicked item. To see an example, refer to the How to: Create a New Object using the Navigation Control topic.

As an alternative to this event, you can override the ShowNavigationItem method in the ShowNavigationItemController‘s descendant.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomShowNavigationItem event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-show-filter-dialog-before-listview/CS/E1554.Module/ShowFilterDialogController.cs#L22

if(showNavigationItemController != null) {
    showNavigationItemController.CustomShowNavigationItem += ShowNavigationItemController_CustomShowNavigationItem;
}

XAF_Non-Persistent-Objects-Edit-Linked-Persistent-Objects-Demo/CS/NonPersistentObjectsDemo.Module/Controllers/NonPersistentObjectActivatorController.cs#L21

if(showNavigationItemController != null) {
    showNavigationItemController.CustomShowNavigationItem += ShowNavigationItemController_CustomShowNavigationItem;
}

xaf-how-to-show-a-new-object-detail-view-via-the-navigation-control/CS/NewObjectFromNavigationExample.Module/Controllers/NewObjectFromNavigationController.cs#L13

    ShowNavigationItemController showNavigationItemController = Frame.GetController<ShowNavigationItemController>();
    showNavigationItemController.CustomShowNavigationItem += showNavigationItemController_CustomShowNavigationItem;
}

VB.NET

XAF_how-to-show-filter-dialog-before-listview/VB/E1554.Module/ShowFilterDialogController.vb#L23

If showNavigationItemController IsNot Nothing Then
    AddHandler showNavigationItemController.CustomShowNavigationItem, AddressOf ShowNavigationItemController_CustomShowNavigationItem
End If

XAF_Non-Persistent-Objects-Edit-Linked-Persistent-Objects-Demo/VB/NonPersistentObjectsDemo.Module/Controllers/NonPersistentObjectActivatorController.vb#L23

If showNavigationItemController IsNot Nothing Then
    AddHandler showNavigationItemController.CustomShowNavigationItem, AddressOf ShowNavigationItemController_CustomShowNavigationItem
End If

xaf-how-to-show-a-new-object-detail-view-via-the-navigation-control/VB/NewObjectFromNavigationExample.Module/Controllers/NewObjectFromNavigationController.vb#L15

    Dim showNavigationItemController As ShowNavigationItemController = Frame.GetController(Of ShowNavigationItemController)()
    AddHandler showNavigationItemController.CustomShowNavigationItem, AddressOf showNavigationItemController_CustomShowNavigationItem
End Sub