Class Navigation

Inheritance

System.Object

Navigation

Namespace: DotNetNuke.UI

Assembly: DotNetNuke.dll

Syntax

public class Navigation : object

Methods

| Improve this Doc View Source

CanShowTab(TabInfo, Boolean, Boolean, Boolean)

Declaration

public static bool CanShowTab(TabInfo tab, bool isAdminMode, bool showDisabled, bool showHidden)

Parameters

Type	Name	Description
TabInfo	tab
System.Boolean	isAdminMode
System.Boolean	showDisabled
System.Boolean	showHidden

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanShowTab(TabInfo, Boolean, Boolean)

Declaration

public static bool CanShowTab(TabInfo objTab, bool isAdminMode, bool showDisabled)

Parameters

Type	Name	Description
TabInfo	objTab
System.Boolean	isAdminMode
System.Boolean	showDisabled

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

GetActionNode(String, String, ModuleAction, Control)

Allows for DNNNode object to be easily obtained based off of passed in ID.

Declaration

public static DNNNode GetActionNode(string strID, string strNamespace, ModuleAction objActionRoot, Control objControl)

Parameters

Type	Name	Description
System.String	strID	NodeID to retrieve.
System.String	strNamespace	Namespace for node collection (usually control's ClientID).
ModuleAction	objActionRoot	Root Action object used in searching.
Control	objControl	ActionControl to base actions off of.

Returns

Type	Description
DNNNode	DNNNode.

Remarks

Primary purpose of this is to obtain the DNNNode needed for the events exposed by the NavigationProvider.

| Improve this Doc View Source

GetActionNodes(ModuleAction, Control, Int32)

This function provides a central location to obtain a generic node collection of the actions associated to a module based off of the current user's context.

Declaration

public static DNNNodeCollection GetActionNodes(ModuleAction objActionRoot, Control objControl, int intDepth)

Parameters

Type	Name	Description
ModuleAction	objActionRoot	Root module action.
Control	objControl	ActionControl to base actions off of.
System.Int32	intDepth	How many levels deep should be populated.

Returns

Type	Description
DNNNodeCollection	A new .

| Improve this Doc View Source

GetActionNodes(ModuleAction, Control)

This function provides a central location to obtain a generic node collection of the actions associated to a module based off of the current user's context.

Declaration

public static DNNNodeCollection GetActionNodes(ModuleAction objActionRoot, Control objControl)

Parameters

Type	Name	Description
ModuleAction	objActionRoot	Root module action.
Control	objControl	ActionControl to base actions off of.

Returns

Type	Description
DNNNodeCollection	A new .

| Improve this Doc View Source

GetActionNodes(ModuleAction, DNNNode, Control, Int32)

This function provides a central location to obtain a generic node collection of the actions associated to a module based off of the current user's context.

Declaration

public static DNNNodeCollection GetActionNodes(ModuleAction objActionRoot, DNNNode objRootNode, Control objControl, int intDepth)

Parameters

Type	Name	Description
ModuleAction	objActionRoot	Root module action.
DNNNode	objRootNode	Root node on which to populate children.
Control	objControl	ActionControl to base actions off of.
System.Int32	intDepth	How many levels deep should be populated.

Returns

Type	Description
DNNNodeCollection	A .

| Improve this Doc View Source

GetNavigationNode(String, String)

Allows for DNNNode object to be easily obtained based off of passed in ID.

Declaration

public static DNNNode GetNavigationNode(string strID, string strNamespace)

Parameters

Type	Name	Description
System.String	strID	NodeID to retrieve.
System.String	strNamespace	Namespace for node collection (usually control's ClientID).

Returns

Type	Description
DNNNode	DNNNode.

Remarks

Primary purpose of this is to obtain the DNNNode needed for the events exposed by the NavigationProvider.

| Improve this Doc View Source

GetNavigationNodes(DNNNode, Navigation.ToolTipSource, Int32, Int32, Int32)

This function provides a central location to obtain a generic node collection of the pages/tabs included in the current context's (user) navigation hierarchy.

Declaration

public static DNNNodeCollection GetNavigationNodes(DNNNode objRootNode, Navigation.ToolTipSource eToolTips, int intStartTabId, int intDepth, int intNavNodeOptions)

Parameters

Type	Name	Description
DNNNode	objRootNode	Node in which to add children to.
Navigation.ToolTipSource	eToolTips	Enumerator to determine what text to display in the tooltips.
System.Int32	intStartTabId	If using Populate On Demand, then this is the tab id of the root element to retrieve (-1 for no POD).
System.Int32	intDepth	If Populate On Demand is enabled, then this parameter determines the number of nodes to retrieve beneath the starting tab passed in (intStartTabId) (-1 for no POD).
System.Int32	intNavNodeOptions	Bitwise integer containing values to determine what nodes to display (self, siblings, parent).

Returns

Type	Description
DNNNodeCollection	Collection of DNNNodes.

Remarks

Returns a subset of navigation nodes based off of passed in starting node id and depth.

| Improve this Doc View Source

GetNavigationNodes(String, Navigation.ToolTipSource, Int32, Int32, Int32)

This function provides a central location to obtain a generic node collection of the pages/tabs included in the current context's (user) navigation hierarchy.

Declaration

public static DNNNodeCollection GetNavigationNodes(string strNamespace, Navigation.ToolTipSource eToolTips, int intStartTabId, int intDepth, int intNavNodeOptions)

Parameters

Type	Name	Description
System.String	strNamespace	Namespace (typically control's ClientID) of node collection to create.
Navigation.ToolTipSource	eToolTips	Enumerator to determine what text to display in the tooltips.
System.Int32	intStartTabId	If using Populate On Demand, then this is the tab id of the root element to retrieve (-1 for no POD).
System.Int32	intDepth	If Populate On Demand is enabled, then this parameter determines the number of nodes to retrieve beneath the starting tab passed in (intStartTabId) (-1 for no POD).
System.Int32	intNavNodeOptions	Bitwise integer containing values to determine what nodes to display (self, siblings, parent).

Returns

Type	Description
DNNNodeCollection	Collection of DNNNodes.

Remarks

Returns a subset of navigation nodes based off of passed in starting node id and depth.

| Improve this Doc View Source

GetNavigationNodes(String)

This function provides a central location to obtain a generic node collection of the pages/tabs included in the current context's (user) navigation hierarchy.

Declaration

public static DNNNodeCollection GetNavigationNodes(string strNamespace)

Parameters

Type	Name	Description
System.String	strNamespace	Namespace (typically control's ClientID) of node collection to create.

Returns

Type	Description
DNNNodeCollection	Collection of DNNNodes.

Remarks

Returns all navigation nodes for a given user.

Extension Methods

JsonExtensionsWeb.ToJson(Object)