NavigatingCancelEventArgs NavigatingCancelEventArgs NavigatingCancelEventArgs NavigatingCancelEventArgs Class

Definition

Provides data for the Navigating event.

public ref class NavigatingCancelEventArgs : System::ComponentModel::CancelEventArgs
public class NavigatingCancelEventArgs : System.ComponentModel.CancelEventArgs
type NavigatingCancelEventArgs = class
    inherit CancelEventArgs
Public Class NavigatingCancelEventArgs
Inherits CancelEventArgs
Inheritance
NavigatingCancelEventArgsNavigatingCancelEventArgsNavigatingCancelEventArgsNavigatingCancelEventArgs

Examples

The following example shows how to handle Navigating to detect whether a request to refresh static content was made, and if one was, how to cancel the request.

Navigating.

void NavigationService_Navigating(object sender, NavigatingCancelEventArgs e)
{
    // Don't allow refreshing of a static page
    if ((e.NavigationMode == NavigationMode.Refresh) &&
        (e.Uri.OriginalString == "StaticPage.xaml"))
    {
        e.Cancel = true;
    }
}
Private Sub NavigationService_Navigating(ByVal sender As Object, ByVal e As NavigatingCancelEventArgs)
    ' Don't allow refreshing of a static page
    If (e.NavigationMode = NavigationMode.Refresh) AndAlso (e.Uri.OriginalString = "StaticPage.xaml") Then
        e.Cancel = True
    End If
End Sub

Remarks

These event arguments contain information about the navigation that was requested, and are passed to handlers of the Navigating event, which is implemented by the following:

NavigatingCancelEventArgs encapsulates the following details of the navigation request:

This information allows you to both evaluate the nature of the navigation request, and view and update specified request details before navigation occurs.

Based on the navigation request information provided by NavigatingCancelEventArgs, or based on application-specific state or code, you can completely prevent navigation by setting the Cancel property to true (by default, Cancel is false).

Properties

Cancel Cancel Cancel Cancel

Gets or sets a value indicating whether the event should be canceled.

(Inherited from CancelEventArgs)
Content Content Content Content

Gets a reference to the content object that is being navigated to.

ContentStateToSave ContentStateToSave ContentStateToSave ContentStateToSave

Gets or sets the CustomContentState object that is associated with the back navigation history entry for the page being navigated from.

ExtraData ExtraData ExtraData ExtraData

Gets the optional data Object that was passed when navigation started.

IsNavigationInitiator IsNavigationInitiator IsNavigationInitiator IsNavigationInitiator

Indicates whether the navigator (NavigationWindow, Frame) that is specified by Navigator is servicing this navigation, or whether a parent navigator is doing so.

NavigationMode NavigationMode NavigationMode NavigationMode

Gets a NavigationMode value that indicates the type of navigation that is occurring.

Navigator Navigator Navigator Navigator

The navigator that raised this event.

TargetContentState TargetContentState TargetContentState TargetContentState

Gets the CustomContentState object that is to be applied to the content being navigated to.

Uri Uri Uri Uri

Gets the uniform resource identifier (URI) for the content being navigated to.

WebRequest WebRequest WebRequest WebRequest

Gets the WebRequest object that is used to request the specified content.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also