BreadcrumbControl.QueryPath Event
Occurs when an end user enters a path into the path edit box. Allows you to provide a collection of nodes that corresponds to end user request.
Namespace: DevExpress.Xpf.Controls
Assembly: DevExpress.Xpf.Controls.v20.2.dll
NuGet Packages: DevExpress.WindowsDesktop.Wpf.Controls, DevExpress.Wpf.Navigation
Declaration
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:
- an end user pastes a path into the path edit box and presses Enter (SelectedPath property changed)
- an end user types a path into the path box and enters a path separator
- on the SelectedItemPath property change.
Handle the QueryPath event to parse the user input and provide a set of the selected breadcrumbs 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 provide a breadcrumb control with a set of selected nodes that correspond to path entered by an end user.