C# Class ScrewTurn.Wiki.NavigationPaths

Manages navigation paths.

Public Methods

Method	Description
AddNavigationPath ( NamespaceInfo nspace, string name, List pages, IPagesStorageProviderV30 provider ) : bool	Adds a new Navigation Path.
Exists ( string name ) : bool	Finds a Navigation Path's Name.
Find ( string fullName ) : NavigationPath	Finds and returns a Path.
GetAllNavigationPaths ( ) : List	Gets the list of the Navigation Paths.
GetNavigationPaths ( NamespaceInfo nspace ) : List	Gets the list of the Navigation Paths in a namespace.
ModifyNavigationPath ( string fullName, List pages ) : bool	Modifies a Navigation Path.
PathsPerPage ( System.PageInfo page ) : string[]	Finds all the Navigation Paths that include a Page.
RemoveNavigationPath ( string fullName ) : bool	Removes a Navigation Path.

Adds a new Navigation Path.

public static AddNavigationPath ( NamespaceInfo nspace, string name, List pages, IPagesStorageProviderV30 provider ) : bool
nspace	NamespaceInfo	The target namespace (null for the root).
name	string	The Name.
pages	List	The Pages.
provider	IPagesStorageProviderV30	The Provider to use for the new Navigation Path, or null for the default provider.
return	bool

Finds a Navigation Path's Name.

public static Exists ( string name ) : bool
name	string	The Name.
return	bool

Finds and returns a Path.

public static Find ( string fullName ) : NavigationPath
fullName	string	The full name.
return	NavigationPath

Gets the list of the Navigation Paths.

public static GetAllNavigationPaths ( ) : List
return	List

Gets the list of the Navigation Paths in a namespace.

public static GetNavigationPaths ( NamespaceInfo nspace ) : List
nspace	NamespaceInfo	The namespace.
return	List

Modifies a Navigation Path.

public static ModifyNavigationPath ( string fullName, List pages ) : bool
fullName	string	The full name of the path to modify.
pages	List	The list of Pages.
return	bool

Finds all the Navigation Paths that include a Page.

public static PathsPerPage ( System.PageInfo page ) : string[]
page	System.PageInfo	The Page.
return	string[]

Removes a Navigation Path.

public static RemoveNavigationPath ( string fullName ) : bool
fullName	string	The full name of the path to remove.
return	bool