Vereinsmeisterschaften.Services.NavigationService Class Reference

Service for handling navigation within the application. More...

Inheritance diagram for Vereinsmeisterschaften.Services.NavigationService:

Public Member Functions
	NavigationService (IPageService pageService)
	Constructor for the NavigationService.
void	Initialize (Frame shellFrame)
	Initializes the navigation service with the provided frame. Parameters shellFrame Use this Frame for navigation
void	UnsubscribeNavigation ()
	Unsubscribes from navigation events and clears the frame reference.
void	GoBack ()
	Goes back to the previous page in the navigation stack if possible.
bool	NavigateTo (string pageKey, object parameter=null, bool clearNavigation=false)
	Navigates to the specified page using its key. Parameters pageKey Page key parameter Optional parameter clearNavigation True to clear the navigation Returns True on navigation success
bool	NavigateTo< T_VM > (object parameter=null, bool clearNavigation=false)
	Navigates to the specified page using its view model type. Parameters parameter Optional parameter clearNavigation True to clear the navigation Returns True on navigation success
bool	ReloadCurrent ()
	Navigate to the current page again.This can be used to trigger the INavigationAware.OnNavigatedTo(object) again. Returns True on navigation success
void	CleanNavigation ()
	Cleans the navigation stack of the frame.

Properties
bool	CanGoBack [get]
	True if the frame can navigate back, false otherwise.
FrameworkElement	CurrentFrameContent [get]
	Current FrameworkElement that is displayed in the Frame.Most times this is a page.
object	CurrentFrameViewModel [get]
	View model used by the CurrentFrameContent

Events
EventHandler< string >	Navigated
Events inherited from Vereinsmeisterschaften.Contracts.Services.INavigationService
EventHandler< string >	Navigated
	Event that is raised when navigation occured.

Private Member Functions
void	OnNavigated (object sender, NavigationEventArgs e)

Private Attributes
readonly IPageService	_pageService
Frame	_frame
object	_lastParameterUsed

Detailed Description

Service for handling navigation within the application.

Definition at line 15 of file NavigationService.cs.

Constructor & Destructor Documentation

NavigationService()

Vereinsmeisterschaften.Services.NavigationService.NavigationService

(

IPageService

pageService

)

Constructor for the NavigationService.

Parameters

pageService

IPageService object

Definition at line 37 of file NavigationService.cs.

Member Function Documentation

CleanNavigation()

void Vereinsmeisterschaften.Services.NavigationService.CleanNavigation

(

)

Cleans the navigation stack of the frame.

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

GoBack()

void Vereinsmeisterschaften.Services.NavigationService.GoBack

(

)

Goes back to the previous page in the navigation stack if possible.

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 60 of file NavigationService.cs.

Initialize()

void Vereinsmeisterschaften.Services.NavigationService.Initialize

(

Frame

shellFrame

)

Initializes the navigation service with the provided frame.

Parameters

shellFrame

Use this Frame for navigation

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 43 of file NavigationService.cs.

NavigateTo()

bool Vereinsmeisterschaften.Services.NavigationService.NavigateTo	(	string	pageKey,
		object	parameter = null,
		bool	clearNavigation = false )

Navigates to the specified page using its key.

Parameters

pageKey	Page key
parameter	Optional parameter
clearNavigation	True to clear the navigation

Returns

True on navigation success

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 74 of file NavigationService.cs.

NavigateTo< T_VM >()

bool Vereinsmeisterschaften.Services.NavigationService.NavigateTo< T_VM >	(	object	parameter = null,
		bool	clearNavigation = false )

Navigates to the specified page using its view model type.

Parameters

parameter	Optional parameter
clearNavigation	True to clear the navigation

Returns

True on navigation success

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 100 of file NavigationService.cs.

OnNavigated()

void Vereinsmeisterschaften.Services.NavigationService.OnNavigated ( object sender, NavigationEventArgs e )

private

Definition at line 129 of file NavigationService.cs.

ReloadCurrent()

bool Vereinsmeisterschaften.Services.NavigationService.ReloadCurrent

(

)

Navigate to the current page again.This can be used to trigger the INavigationAware.OnNavigatedTo(object) again.

Returns

True on navigation success

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 106 of file NavigationService.cs.

UnsubscribeNavigation()

void Vereinsmeisterschaften.Services.NavigationService.UnsubscribeNavigation

(

)

Unsubscribes from navigation events and clears the frame reference.

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 53 of file NavigationService.cs.

Member Data Documentation

_frame

Frame Vereinsmeisterschaften.Services.NavigationService._frame

private

Definition at line 18 of file NavigationService.cs.

_lastParameterUsed

object Vereinsmeisterschaften.Services.NavigationService._lastParameterUsed

private

Definition at line 19 of file NavigationService.cs.

_pageService

readonly IPageService Vereinsmeisterschaften.Services.NavigationService._pageService

private

Definition at line 17 of file NavigationService.cs.

Property Documentation

CanGoBack

bool Vereinsmeisterschaften.Services.NavigationService.CanGoBack

get

True if the frame can navigate back, false otherwise.

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 25 of file NavigationService.cs.

CurrentFrameContent

FrameworkElement Vereinsmeisterschaften.Services.NavigationService.CurrentFrameContent

get

Current FrameworkElement that is displayed in the Frame.Most times this is a page.

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 28 of file NavigationService.cs.

CurrentFrameViewModel

object Vereinsmeisterschaften.Services.NavigationService.CurrentFrameViewModel

get

View model used by the CurrentFrameContent

Implements Vereinsmeisterschaften.Contracts.Services.INavigationService.

Definition at line 31 of file NavigationService.cs.

Event Documentation

Navigated

EventHandler<string> Vereinsmeisterschaften.Services.NavigationService.Navigated

Definition at line 22 of file NavigationService.cs.

---

The documentation for this class was generated from the following file:

• /github/workspace/Vereinsmeisterschaften/Services/NavigationService.cs