NavigatingCancelEventArgs Class

Definition

Namespace:

System.Windows.Navigation

Assembly:

PresentationFramework.dll

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

Object

EventArgs

CancelEventArgs

NavigatingCancelEventArgs

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:

• NavigationService.Navigating

• NavigationWindow.Navigating

• Frame.Navigating

• Application.Navigating

NavigatingCancelEventArgs encapsulates the following details of the navigation request:

• Navigation Initiation: NavigationMode, Navigator, IsNavigationInitiator.

• Navigation Content: Uri, Content.

• Navigation Request: WebRequest.

• Navigation State: ExtraData, ContentStateToSave, TargetContentState.

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	Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs)
Content	Gets a reference to the content object that is being navigated to.
ContentStateToSave	Gets or sets the CustomContentState object that is associated with the back navigation history entry for the page being navigated from.
ExtraData	Gets the optional data Object that was passed when navigation started.
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	Gets a NavigationMode value that indicates the type of navigation that is occurring.
Navigator	The navigator that raised this event.
TargetContentState	Gets the CustomContentState object that is to be applied to the content being navigated to.
Uri	Gets the uniform resource identifier (URI) for the content being navigated to.
WebRequest	Gets the WebRequest object that is used to request the specified content.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• Navigating