BreadcrumbControl.QueryPath Event

Occurs when a user enters a path into the path edit box. Allows you to populate a breadcrumb control with a collection of nodes that corresponds to the user request.

Namespace : DevExpress.Xpf.Controls

Assembly : DevExpress.Xpf.Controls.v25.2.dll

NuGet Package : DevExpress.Wpf.Controls

csharp

public event EventHandler<BreadcrumbQueryPathEventArgs> QueryPath

Public Event QueryPath As EventHandler(Of BreadcrumbQueryPathEventArgs)

Event Data

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

Property	Description
Breadcrumbs	Gets or sets a set of breadcrumb items that correspond to the path entered by an end user.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
Path	Gets the path entered by an end user.
PathSeparator	Gets a separator used to separate path items.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The QueryPath event occurs in the following cases:

A user types or pastes a path into the path edit box.
A user selects a path in the MRU drop-down.
You change the BreadcrumbControl.SelectedItemPath property.

Handle the QueryPath event to parse the user input and return a set of the selected breadcrumb items.

The event arguments expose the BreadcrumbQueryPathEventArgs.Path property that returns a set of strings separated by a path separator.

Use the BreadcrumbQueryPathEventArgs.Breadcrumbs property to populate a breadcrumb control with a set of selected nodes that corresponds to the path entered by a user.