Class NavigationSettings

Namespace

Dynamicweb.Frontend.Navigation

Assembly

Dynamicweb.dll

Provides information about what to include in a navigation.

public class NavigationSettings

Inheritance

object

NavigationSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ExpandMode

The expand mode for the navigation. Defaults to Path if null.

public ExpandMode ExpandMode { get; set; }

Property Value

ExpandMode

IncludeFoldersAndHidden

This will include folders and hidden pages that normally is not shown in navigation. Can be used to render navigation nodes that is part of folders or where parents are not published.

public bool IncludeFoldersAndHidden { get; set; }

Property Value

bool

Remarks

Gets or sets a setting that will include all pages in the returned navigation structure.

Parameters

A collection of custom parameters (provided in the template).

public IDictionary<string, object> Parameters { get; set; }

Property Value

IDictionary<string, object>

RootAreaId

The ID of the area (webiste) which should be the root of the navigation.

public int RootAreaId { get; set; }

Property Value

int

RootNavigationTag

The navigation tag of the page which should be the root of the navigation.

public string RootNavigationTag { get; set; }

Property Value

string

RootPageId

The ID of the page which should be the root of the navigation.

public int RootPageId { get; set; }

Property Value

int

StartLevel

The node level from which the navigation nodes should be included. Defaults to 1 if null.

public int StartLevel { get; set; }

Property Value

int

StopLevel

The node level to which the navigation nodes should be included. Defaults to 99 if null.

public int StopLevel { get; set; }

Property Value

int