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
Namespace: DotNetNuke.UIAssembly: DotNetNuke (in DotNetNuke.dll)
Syntax
C# |
---|
public static DNNNodeCollection GetNavigationNodes( DNNNode objRootNode, Navigation..::..ToolTipSource eToolTips, int intStartTabId, int intDepth, int intNavNodeOptions ) |
Visual Basic |
---|
Public Shared Function GetNavigationNodes ( objRootNode As DNNNode, eToolTips As Navigation..::..ToolTipSource, intStartTabId As Integer, intDepth As Integer, intNavNodeOptions As Integer ) As DNNNodeCollection |
Parameters
- objRootNode
- Type: DotNetNuke.UI.WebControls..::..DNNNode
Node in which to add children to
- eToolTips
- Type: DotNetNuke.UI..::..Navigation..::..ToolTipSource
Enumerator to determine what text to display in the tooltips
- intStartTabId
- Type: System..::..Int32
If using Populate On Demand, then this is the tab id of the root element to retrieve (-1 for no POD)
- intDepth
- Type: System..::..Int32
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)
- intNavNodeOptions
- Type: System..::..Int32
Bitwise integer containing values to determine what nodes to display (self, siblings, parent)
Return Value
Collection of DNNNodes
Remarks
Returns a subset of navigation nodes based off of passed in starting node id and depth