Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

NavigationService.GetNavigationService Method (DependencyObject)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 static NavigationService GetNavigationService(
	DependencyObject dependencyObject
)

Parameters

dependencyObject
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
ArgumentNullException

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.

void getNavigationServiceButton_Click(object sender, RoutedEventArgs e) {
    // Retrieve first navigation service up the content tree
    NavigationService svc = NavigationService.GetNavigationService(this.getNavigationServiceButton);
    if (svc != null)
    {
        // Use navigation service
    }
}

.NET Framework
Available since 3.0
Return to top
Show:
© 2018 Microsoft