• Article

NavigationFailedEventArgs Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides data for the NavigationFailed event of the NavigationService class and the NavigationFailed event of the Frame class.

Inheritance Hierarchy

System.Object
  System.EventArgs
    System.Windows.Navigation.NavigationFailedEventArgs

Namespace:  System.Windows.Navigation
Assembly:  System.Windows.Controls.Navigation (in System.Windows.Controls.Navigation.dll)

Syntax

'Declaration
Public NotInheritable Class NavigationFailedEventArgs _
    Inherits EventArgs

public sealed class NavigationFailedEventArgs : EventArgs

The NavigationFailedEventArgs type exposes the following members.

Properties

  Name Description
Public property Exception Gets the error from the failed navigation.
Public property Handled Gets or sets a value that indicates whether the failure event has been handled.
Public property Uri Gets the uniform resource identifier (URI) for the content that could not be navigated to.

Top

Methods

  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

You use the NavigationFailedEventArgs object to retrieve information about a navigation request that could not be completed successfully. The Handled property enables you to set whether an exception should be thrown after the event handler has been processed.

Examples

The following example shows a handler for the NavigationFailed event of the Frame class. When navigation to a page within the frame fails, a child window is displayed that contains an error message and the URI of the requested page. The code for the child window named ErrorWindow is not shown in this example, but must be included in the application for the example to work. The Handled property is set to true to indicate that the event has been handled and an exception should not be thrown.

Private Sub ContentFrame_NavigationFailed(ByVal sender As Object, _
         ByVal e As NavigationFailedEventArgs) Handles ContentFrame.NavigationFailed
    e.Handled = True
    Dim errorWindow As ChildWindow = New ErrorWindow(e.Uri)
    errorWindow.Show()
End Sub

private void ContentFrame_NavigationFailed(object sender, NavigationFailedEventArgs e)
{
    e.Handled = true;
    ChildWindow errorWin = new ErrorWindow(e.Uri);
    errorWin.Show();
}

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.