Vereinsmeisterschaften.Contracts.Services.INavigationService Interface Reference

Interface for a service for handling navigation within the application. More...

Inheritance diagram for Vereinsmeisterschaften.Contracts.Services.INavigationService:

Public Member Functions
void	Initialize (Frame shellFrame)
	Initializes the navigation service with the provided frame.
bool	NavigateTo (string pageKey, object parameter=null, bool clearNavigation=false)
	Navigates to the specified page using its key.
bool	NavigateTo< T_VM > (object parameter=null, bool clearNavigation=false)
	Navigates to the specified page using its view model type.
bool	ReloadCurrent ()
	Navigate to the current page again.
void	GoBack ()
	Goes back to the previous page in the navigation stack if possible.
void	UnsubscribeNavigation ()
	Unsubscribes from navigation events and clears the frame reference.
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.
object	CurrentFrameViewModel [get]
	View model used by the CurrentFrameContent

Events
EventHandler< string >	Navigated
	Event that is raised when navigation occured.

Detailed Description

Interface for a service for handling navigation within the application.

Definition at line 10 of file INavigationService.cs.

Member Function Documentation

CleanNavigation()

void Vereinsmeisterschaften.Contracts.Services.INavigationService.CleanNavigation

(

)

Cleans the navigation stack of the frame.

Implemented in Vereinsmeisterschaften.Services.NavigationService.

GoBack()

void Vereinsmeisterschaften.Contracts.Services.INavigationService.GoBack

(

)

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

Implemented in Vereinsmeisterschaften.Services.NavigationService.

Initialize()

void Vereinsmeisterschaften.Contracts.Services.INavigationService.Initialize

(

Frame

shellFrame

)

Initializes the navigation service with the provided frame.

Parameters

shellFrame

Use this Frame for navigation

Implemented in Vereinsmeisterschaften.Services.NavigationService.

NavigateTo()

bool Vereinsmeisterschaften.Contracts.Services.INavigationService.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

Implemented in Vereinsmeisterschaften.Services.NavigationService.

NavigateTo< T_VM >()

bool Vereinsmeisterschaften.Contracts.Services.INavigationService.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

Implemented in Vereinsmeisterschaften.Services.NavigationService.

ReloadCurrent()

bool Vereinsmeisterschaften.Contracts.Services.INavigationService.ReloadCurrent

(

)

Navigate to the current page again.

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

Returns

True on navigation success

Implemented in Vereinsmeisterschaften.Services.NavigationService.

UnsubscribeNavigation()

void Vereinsmeisterschaften.Contracts.Services.INavigationService.UnsubscribeNavigation

(

)

Unsubscribes from navigation events and clears the frame reference.

Implemented in Vereinsmeisterschaften.Services.NavigationService.

Property Documentation

CanGoBack

bool Vereinsmeisterschaften.Contracts.Services.INavigationService.CanGoBack

get

True if the frame can navigate back, false otherwise.

Implemented in Vereinsmeisterschaften.Services.NavigationService.

Definition at line 20 of file INavigationService.cs.

CurrentFrameContent

FrameworkElement Vereinsmeisterschaften.Contracts.Services.INavigationService.CurrentFrameContent

get

Current FrameworkElement that is displayed in the Frame.

Most times this is a page.

Implemented in Vereinsmeisterschaften.Services.NavigationService.

Definition at line 25 of file INavigationService.cs.

CurrentFrameViewModel

object Vereinsmeisterschaften.Contracts.Services.INavigationService.CurrentFrameViewModel

get

View model used by the CurrentFrameContent

Implemented in Vereinsmeisterschaften.Services.NavigationService.

Definition at line 30 of file INavigationService.cs.

Event Documentation

Navigated

EventHandler<string> Vereinsmeisterschaften.Contracts.Services.INavigationService.Navigated

Event that is raised when navigation occured.

Definition at line 15 of file INavigationService.cs.

---

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

• /github/workspace/Vereinsmeisterschaften/Contracts/Services/INavigationService.cs