GetNavigationService Method

NavigationService.GetNavigationService Method (DependencyObject)


Gets a reference to the NavigationService for the navigator whose content contains the specified DependencyObject.

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

Public Shared Function GetNavigationService (
	dependencyObject As DependencyObject
) As NavigationService


Type: System.Windows.DependencyObject

The DependencyObject in content that is hosted by a navigator.

Return Value

Type: System.Windows.Navigation.NavigationService

A reference to the NavigationService for the navigator whose content contains the specified DependencyObject; can be null in some cases (see Remarks).

Exception Condition

The dependencyObject parameter is null.

A navigator has a NavigationService that handles content navigation. WPF has two navigators: NavigationWindow and Frame. To process navigation requests and manage navigation lifetime, a navigator uses the WPF navigation service, which is implemented as the NavigationService class. Content that is hosted by a navigator can get a reference to the navigator's NavigationService by calling the GetNavigationService method.

GetNavigationService returns null when the dependencyObject:

WPF offers two shortcuts for acquiring a reference to the NavigationService:

The following example shows how a UserControl can retrieve a navigation service by calling GetNavigationService.

Private Sub getNavigationServiceButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    ' Retrieve first navigation service up the content tree
    Dim svc As NavigationService = NavigationService.GetNavigationService(Me.getNavigationServiceButton)
    If svc IsNot Nothing Then
        ' Use navigation service
    End If
End Sub

.NET Framework
Available since 3.0
Return to top
© 2015 Microsoft