Share via

PortalSiteMapProvider.GetChildNodes Method (PortalSiteMapNode, NodeTypes, NodeTypes, OrderingMethod, AutomaticSortingMethod, Boolean, Int32)

  • Article

Returns a sorted, security-trimmed collection of child nodes for a specified parent node, types of nodes to include, types of hidden nodes to include, and sorting options.

Namespace:  Microsoft.SharePoint.Publishing.Navigation
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
Public Overridable Function GetChildNodes ( _
    node As PortalSiteMapNode, _
    includedTypes As NodeTypes, _
    includedHiddenTypes As NodeTypes, _
    ordering As OrderingMethod, _
    method As AutomaticSortingMethod, _
    ascending As Boolean, _
    lcid As Integer _
) As SiteMapNodeCollection

'Usage
Dim instance As PortalSiteMapProvider
Dim node As PortalSiteMapNode
Dim includedTypes As NodeTypes
Dim includedHiddenTypes As NodeTypes
Dim ordering As OrderingMethod
Dim method As AutomaticSortingMethod
Dim ascending As Boolean
Dim lcid As Integer
Dim returnValue As SiteMapNodeCollection

returnValue = instance.GetChildNodes(node, _
    includedTypes, includedHiddenTypes, _
    ordering, method, ascending, lcid)

public virtual SiteMapNodeCollection GetChildNodes(
    PortalSiteMapNode node,
    NodeTypes includedTypes,
    NodeTypes includedHiddenTypes,
    OrderingMethod ordering,
    AutomaticSortingMethod method,
    bool ascending,
    int lcid
)

Parameters

  • ascending
    Type: System.Boolean
    Whether to use ascending or descending order.
  • lcid
    Type: System.Int32
    Locale ID to use for culture sorting.

Return Value

Type: System.Web.SiteMapNodeCollection
A collection of child nodes of types specified that are sorted as specified.

Examples

The following example references the following assemblies:

  • System.dll

  • System.Data.dll

  • System.Xml.dll

  • System.Web.dll

  • System.Configuration.dll

  • Microsoft.SharePoint.dll

  • Microsoft.SharePoint.Library.dll

  • Microsoft.SharePoint.Publishing.dll

using System;
using System.Collections.Generic;
using System.Text;
using System.Data;
using System.Web;

using Microsoft.SharePoint;
using Microsoft.SharePoint.Navigation;

using Microsoft.SharePoint.Publishing;
using Microsoft.SharePoint.Publishing.Navigation;

namespace Microsoft.SDK.SharePointServer.Samples
{
    class GetChildNodesSample
    {
        // Get a list of the navigation headings beneath a specified
        // Web site in current navigation. This method must be called from
        // within a current and valid HttpContext object.
        public static List<string>GetNavigationHeadingTitles(string serverRelativeWebUrl)
        {
            List<string> titles = null;

            // Get a reference to the current navigation provider:
            // the one that doesn't HTML-encode titles.
            PortalSiteMapProvider portalProvider = PortalSiteMapProvider.CurrentNavSiteMapProviderNoEncode;
            // lookup the node for the given Web site URL.
            PortalWebSiteMapNode webNode = 
                portalProvider.FindSiteMapNode(serverRelativeWebUrl) as PortalWebSiteMapNode;

            if (webNode != null)
            {
                // Retrieve the heading nodes beneath the 
                // specified Web site.
                SiteMapNodeCollection headingNodes = 
                    portalProvider.GetChildNodes(webNode, NodeTypes.Heading, NodeTypes.None);

                titles = new List<string>(headingNodes.Count);

                foreach (PortalSiteMapNode headingNode in headingNodes)
                {
                    // Add the title to the list.
                    titles.Add(headingNode.Title);
                }
            }

            // Return the list of titles.
            return titles;
        }
    }
}

See Also

Reference

PortalSiteMapProvider Class

PortalSiteMapProvider Members

GetChildNodes Overload

Microsoft.SharePoint.Publishing.Navigation Namespace

PortalSiteMapProvider