Table of Contents

Class NavigationTreeNode

Namespace
Dynamicweb.Frontend.Navigation
Assembly
Dynamicweb.dll

Represents a navigation tree node.

public abstract class NavigationTreeNode
Inheritance
NavigationTreeNode
Inherited Members

Constructors

NavigationTreeNode(string)

protected NavigationTreeNode(string nodeId)

Parameters

nodeId string

Properties

AreaId

Gets or sets the area id of the page that this navigation node represents.

public int AreaId { get; set; }

Property Value

int

The area id that this node links.

GroupId

Gets or sets the group id of the ecommerce group that this navigation node represents.

public string? GroupId { get; set; }

Property Value

string

The group id of the group that this node links to. If the node is not a ecommerce group, the group id is empty.

IsClickable

Gets or sets a value indicating whether the node should be clickable (link).

public bool IsClickable { get; set; }

Property Value

bool

true if active; otherwise, false.

Level

Gets or sets the level of the node in the navigation tree relative to the root.

public int Level { get; set; }

Property Value

int

The level.

Gets or sets the link of the node, i.e /home/products or /products/bikes/mountain-bike.

public string? Link { get; set; }

Property Value

string

The link.

Name

Gets or sets the name of node - the page name, group name etc.

public string? Name { get; set; }

Property Value

string

The name.

NodeId

public string NodeId { get; }

Property Value

string

PageId

Gets or sets the pageid of the page that this navigation node represents.

public int PageId { get; set; }

Property Value

int

The page id that this node links to. If the node is not a page, i.e. an Ecommerce group, the pageid is the id of the page where the ecommerce navigation is attached.

ShowInBreadcrumb

Gets or sets a value indicating weather the node should be shown in breadcrumb

public bool ShowInBreadcrumb { get; set; }

Property Value

bool

ShowInMenu

Gets or sets a value indicating weather the node should be shown in menu. Will always be true except if explicitly included

public bool ShowInMenu { get; set; }

Property Value

bool

ShowInSitemap

Gets or sets a value indicating weather the node should be shown in sitemap

public bool ShowInSitemap { get; set; }

Property Value

bool

Methods

GetNodes(NavigationContext, NavigationSettings)

Gets the sub nodes (children) to this navigation node.

public IEnumerable<NavigationTreeNode> GetNodes(NavigationContext context, NavigationSettings settings)

Parameters

context NavigationContext
settings NavigationSettings

Returns

IEnumerable<NavigationTreeNode>

IsActive(NavigationContext)

Gets a value indicating whether node is active.

public bool IsActive(NavigationContext context)

Parameters

context NavigationContext

Returns

bool

IsInPath(NavigationContext)

Gets a value indicating whether node is in path.

public bool IsInPath(NavigationContext context)

Parameters

context NavigationContext

Returns

bool

See Also

NavigationTree
To top