Class NavigatorCore

Provides the base implementation of a navigator that manages route-based navigation with a hierarchy of views.

Inheritance

object

NavigatorCore

Navigator

Implements

INavigator

IDialogPresenter

INotifyPropertyChanged

Namespace: Singulink.UI.Navigation

Assembly: Singulink.UI.Navigation.dll

Syntax

public abstract class NavigatorCore : INavigator, IDialogPresenter, INotifyPropertyChanged

Constructors

Name	Description
NavigatorCore(object, ITaskRunner, NavigatorBuilderCore)	Initializes a new instance of the NavigatorCore class.

Properties

Name	Description
CanGoBack	Gets a value indicating whether the navigator can navigate back to the previous view. This property can be used to bind the enabled state of a back button in the UI and should be checked before calling GoBackAsync().
CanGoForward	Gets a value indicating whether the navigator can navigate forward to the next view. This property can be used to bind the enabled state of a forward button in the UI and should be checked before calling GoForwardAsync().
CanRefresh	Gets a value indicating whether the navigator can refresh the current view. This property can be used to bind the enabled state of a refresh button or "pull to refresh" feature in the UI and should be checked before calling RefreshAsync().
CurrentRoute	Gets information about the current route, including the path and options.
HasBackHistory	Gets a value indicating whether the navigator has back history.
HasForwardHistory	Gets a value indicating whether the navigator has forward history.
IsNavigating	Gets a value indicating whether the navigator is currently in the process of navigating to a new view.
IsShowingDialog	Gets a value indicating whether the navigator is currently showing a dialog.
RootServices	Gets the root service provider for this navigator. This property can be accessed from any thread.
TaskRunner	Gets the task runner for this navigator. This property can be accessed from any thread.

Methods

Name	Description
ClearHistoryAsync()	Clears back and forward navigation history.
CloseLightDismissPopups()	Closes any light-dismiss popups that are currently open.
CurrentPathStartsWith<TRootViewModel>(IConcreteRootRoutePart<TRootViewModel>, IConcreteChildRoutePart<TRootViewModel>)	Determines whether the current route path starts with the same path as the specified route.
CurrentPathStartsWith<TRootViewModel, TChildViewModel1>(IConcreteRootRoutePart<TRootViewModel>, IConcreteChildRoutePart<TRootViewModel, TChildViewModel1>, IConcreteChildRoutePart<TChildViewModel1>)	Determines whether the current route path starts with the same path as the specified route.
CurrentPathStartsWith<TRootViewModel, TChildViewModel1, TChildViewModel2>(IConcreteRootRoutePart<TRootViewModel>, IConcreteChildRoutePart<TRootViewModel, TChildViewModel1>, IConcreteChildRoutePart<TChildViewModel1, TChildViewModel2>, IConcreteChildRoutePart<TChildViewModel2>)	Determines whether the current route path starts with the same path as the specified route.
CurrentRouteHasParent<TViewModel>()	Determines whether the current route contains a parent view with the specified view model type.
EnsureThreadAccess()	Ensures that the current call is happening on the required thread.
GetBackStack()	Returns the routes that are in the back navigation stack, ordered from the most recent to the oldest. Does not include the current route.
GetCurrentRoutePartsToParent(Type)	Gets the current route parts up to the specified parent view model type.
GetForwardStack()	Returns a list of routes currently in the forward navigation stack. Does not include the current route.
GoBackAsync()	Navigates back to the previous view.
GoForwardAsync()	Navigates forward to the next view.
HandleSystemBackRequest()	Handles a system back request, such as when the user presses the back button on a mobile device, a hardware back button on a desktop or the back button in a web browser. Returns true if there is a dialog showing, a light dismiss popup was closed, a navigation is currently in progress or if a back navigation was initiated; otherwise false (meaning there was no back history).
HandleSystemForwardRequest()	Handles a system forward request, such as when the user presses the forward button on a mobile device, a hardware forward button on a desktop or the forward button in a web browser. Returns true if there is a dialog showing, a navigation is currently in progress or if a forward navigation was initiated; otherwise false (meaning there was no forward history).
HideDialog(object)	Hides the specified framework dialog object.
NavigateAsync(IConcreteRootRoutePart, string?)	Navigates to the specified route.
NavigateAsync(string)	Navigates to the specified route.
NavigateAsync<TRootViewModel>(IConcreteRootRoutePart<TRootViewModel>, IConcreteChildRoutePart<TRootViewModel>, string?)	Navigates to the specified route.
NavigateAsync<TRootViewModel, TChildViewModel1>(IConcreteRootRoutePart<TRootViewModel>, IConcreteChildRoutePart<TRootViewModel, TChildViewModel1>, IConcreteChildRoutePart<TChildViewModel1>, string?)	Navigates to the specified route.
NavigateAsync<TRootViewModel, TChildViewModel1, TChildViewModel2>(IConcreteRootRoutePart<TRootViewModel>, IConcreteChildRoutePart<TRootViewModel, TChildViewModel1>, IConcreteChildRoutePart<TChildViewModel1, TChildViewModel2>, IConcreteChildRoutePart<TChildViewModel2>, string?)	Navigates to the specified route.
NavigatePartialAsync(string?)	Navigates to a partial route that has the same path as the current route but with the specified options.
NavigatePartialAsync<TParentViewModel>(IConcreteChildRoutePart<TParentViewModel>, string?)	Navigates to the specified partial route. The current route must contain a view with the specified parent view model type otherwise an InvalidOperationException is thrown.
NavigatePartialAsync<TParentViewModel, TChildViewModel1>(IConcreteChildRoutePart<TParentViewModel, TChildViewModel1>, IConcreteChildRoutePart<TChildViewModel1>, string?)	Navigates to the specified partial route. The current route must contain a view with the specified parent view model type otherwise an InvalidOperationException is thrown.
NavigatePartialAsync<TParentViewModel, TChildViewModel1, TChildViewModel2>(IConcreteChildRoutePart<TParentViewModel, TChildViewModel1>, IConcreteChildRoutePart<TChildViewModel1, TChildViewModel2>, IConcreteChildRoutePart<TChildViewModel2>, string?)	Navigates to the specified partial route. The current route must contain a view with the specified parent view model type otherwise an InvalidOperationException is thrown.
NavigateToParentAsync<TParentViewModel>(string?)	Navigates to the parent view in the current route that has the specified view model type.
OnCurrentRouteChanged(NavigatorRoute)	Called when the current route changes.
RefreshAsync()	Refreshes the current route.
SetActiveView(object, object?)	Sets the active view in the specified view navigator.
ShowDialogAsync(IDialogViewModel)	Shows a dialog with the specified view model and returns a task that completes when the dialog closes.
ShowDialogAsync<TResult>(IDialogViewModel<TResult>)	Shows a dialog with the specified view model and returns a task that completes with the dialog result when the dialog closes.
StartShowingDialog(object)	Starts showing the specified framework dialog object. This is invoked in a fire-and-forget manner; awaiting completion of the dialog is handled by the core orchestration via the dialog's TaskCompletionSource.
TryGetTopDialog()	Returns the dialog navigator and view model for the top showing dialog, or null if no dialog is currently showing.
TryShutDownAsync()	Shuts down the navigator by releasing all views and view model resources. Returns false if shutdown, navigation or busy tasks are in progress, dialogs are showing, or any view models are preventing navigating away from the current view; otherwise returns true after successfully shutting down.
UpdateCurrentRoute(IConcreteRoutePart, string?)	Updates the last route part of the current route in-place without triggering any navigation lifecycle events. The new route part must have a view model type that matches the last route part of the current route. This is useful when a route changes in response to an action (e.g. a form submission that creates a new entry and transitions from a "new-entry" to an "entry/{id}" route) without causing a full navigation.
UpdateCurrentRoute(string?)	Updates the current route in-place without triggering any navigation lifecycle events. This is useful for updating the anchor or other options in response to UI state changes (e.g. selected item in a list) without causing a full navigation.
WireDialog(object, IDialogViewModel, out ITaskRunner)	Wires up a newly created framework-specific dialog object with the specified view model. The implementation should attach the view model as the dialog's data context, hook up any framework-specific bindings/event handlers, and produce a task runner used to run dialog operations.
WireView(object, IRoutedViewModelBase, out object?)	Wires up a newly materialized view with the specified view model. The implementation should attach the view model as the view's data context, hook up any framework-specific bindings/event handlers, and produce the child view navigator if the view is a parent view.