Class Navigation

Represents a navigation context for the application.

Inheritance

object

Navigation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public sealed class Navigation

Constructors

Navigation()

Initializes a new instance of the Navigation class.

Declaration

public Navigation()

Navigation(string)

Initializes a new instance of the Navigation class with the specified encrypted navigation string.

Declaration

public Navigation(string encryptedNav)

Parameters

Type	Name	Description
string	encryptedNav	The encrypted navigation string.

Navigation(string[])

Initializes a new instance of the Navigation class with an array of strings representing steps in the navigation path.

Declaration

public Navigation(string[] steps)

Parameters

Type	Name	Description
string[]	steps	An array of strings representing steps in the navigation path.

Properties

Current

Gets the current step in the navigation context.

Declaration

public Navigation.Step Current { get; }

Property Value

Type	Description
Navigation.Step

Nav

Gets the serialized navigation context in a URL-safe base64-encoded string format.

Declaration

public string Nav { get; }

Property Value

Type	Description
string

NavigationPath

Gets the navigation path as a string.

Declaration

public string NavigationPath { get; }

Property Value

Type	Description
string

Parent

Gets the parent step in the navigation context.

Declaration

public Navigation.Step Parent { get; }

Property Value

Type	Description
Navigation.Step

Steps

Gets or sets the list of steps for the navigation context.

Declaration

public List<Navigation.Step> Steps { get; set; }

Property Value

Type	Description
List<Navigation.Step>

Methods

Clone()

Creates a new Navigation object that is a clone of the current object.

Declaration

public Navigation Clone()

Returns

Type	Description
Navigation	A new Navigation object that is a clone of the current object.

GetCurrentSegment()

Gets the current segment of the navigation.

Declaration

public Navigation GetCurrentSegment()

Returns

Type	Description
Navigation	A new instance of the Navigation class with the current segment of the navigation.

GetSegments()

Gets a list of segments in the navigation.

Declaration

public List<Navigation> GetSegments()

Returns

Type	Description
List<Navigation>	A list of Navigation objects representing the segments in the navigation.

GoBack()

Removes the last step from the current navigation. If the last step is hidden, then it is also removed and the method is called again recursively until the last visible step is reached.

Declaration

public void GoBack()