StaticSiteMapProvider.GetChildNodes Method (SiteMapNode)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Retrieves the child site map nodes of a specific SiteMapNode object.

Namespace:   System.Web
Assembly:  System.Web (in System.Web.dll)

Public Overrides Function GetChildNodes (
	node As SiteMapNode
) As SiteMapNodeCollection

Parameters

node
Type: System.Web.SiteMapNode

The SiteMapNode for which to retrieve all child site map nodes.

Return Value

Type: System.Web.SiteMapNodeCollection

A read-only SiteMapNodeCollection that contains the child site map nodes of node. If security trimming is enabled, the collection contains only site map nodes that the user is permitted to see.

Exception Condition
ArgumentNullException

node is null.

The SiteMapNode objects delegate to the site map provider to keep track of their child and parent site map nodes. As a result, classes that implement a site map provider for a hierarchical site map structure, such as StaticSiteMapProvider, and use SiteMapNode objects to represent site map nodes, must track the hierarchical relationships of all site map nodes in order to be able to navigate an entire hierarchical tree.

The GetChildNodes method calls the BuildSiteMap method internally to retrieve read-only SiteMapNodeCollection collection of site map nodes that are relative to the specified site map node and relevant to the current user.

.NET Framework
Available since 2.0
Return to top
Show: