wpf-devexpress-dot-xpf-dot-editors-dot-hyperlinkedit.md
Fires when a hyperlink is about to be navigated. This is a routed event.
Namespace : DevExpress.Xpf.Editors
Assembly : DevExpress.Xpf.Core.v25.2.dll
NuGet Package : DevExpress.Wpf.Core
public event HyperlinkEditRequestNavigationEventHandler RequestNavigation
Public Event RequestNavigation As HyperlinkEditRequestNavigationEventHandler
The RequestNavigation event's data class is HyperlinkEditRequestNavigationEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Cancel | Cancels the hyperlink navigation. |
| 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. |
| NavigationUrl | Gets or sets the URL that is about to be navigated. |
| OriginalSource | Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs. |
| 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. |
| Value | Gets the edit value of the HyperlinkEdit that has raised the HyperlinkEdit.RequestNavigation event. |
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. |
The RequestNavigation event occurs before the hyperlink is navigated.
To cancel the navigation, set the HyperlinkEditRequestNavigationEventArgs.Cancel property to true.
To modify the URL that is about to be navigated, use the event’s HyperlinkEditRequestNavigationEventArgs.NavigationUrl property.
The code sample below demonstrates how to add the mailto: prefix for the HyperlinkEdit control’s displayed text (to enable opening a mail client).
<dxe:HyperlinkEdit
x:Name="editor"
AllowAutoNavigate="True"
NavigationUrl="[email protected]"
RequestNavigation="HyperlinkEdit_OnRequestNavigation"/>
void HyperlinkEdit_OnRequestNavigation(object sender, HyperlinkEditRequestNavigationEventArgs e) {
string emailUri = "mailto:" + e.NavigationUrl;
e.NavigationUrl = emailUri;
e.Handled = true;
}
Private Sub HyperlinkEdit_OnRequestNavigation(ByVal sender As Object, ByVal e As HyperlinkEditRequestNavigationEventArgs)
Dim emailUri As String = "mailto:" & e.NavigationUrl
e.NavigationUrl = emailUri
e.Handled = True
End Sub
See Also