SiteMapNode.GetAllNodes Method

Definition

Namespace:

System.Web

Assembly:

System.Web.dll

Retrieves a read-only collection of all SiteMapNode objects that are descendants of the calling node, regardless of the degree of separation.

public:
 System::Web::SiteMapNodeCollection ^ GetAllNodes();

public System.Web.SiteMapNodeCollection GetAllNodes ();

member this.GetAllNodes : unit -> System.Web.SiteMapNodeCollection

Public Function GetAllNodes () As SiteMapNodeCollection

Returns

SiteMapNodeCollection

A read-only SiteMapNodeCollection that represents all the descendants of a SiteMapNode within the scope of the current provider.

Examples

The following code example demonstrates how to retrieve all the child nodes of the RootNode with the GetAllNodes method.

SiteMapNodeCollection siteNodes = SiteMap.RootNode.GetAllNodes();

if ( siteNodes.IsReadOnly ||
     siteNodes.IsFixedSize )
{
    Response.Write("Collection is read-only or has fixed size.<BR>");

    // Create a new, modifiable collection from the existing one.
    SiteMapNodeCollection modifiableCollection =
         new SiteMapNodeCollection(siteNodes);

    // The MoveNode example method moves a node from position one to
    // the last position in the collection.
    MoveNode(modifiableCollection);
}
else {
    MoveNode(siteNodes);
}

Dim siteNodes As SiteMapNodeCollection
siteNodes = SiteMap.RootNode.GetAllNodes()

If siteNodes.IsReadOnly Or siteNodes.IsFixedSize Then

    Response.Write("Collection is read-only or has fixed size.<BR>")

    ' Create a new, modifiable collection from the existing one.
    Dim modifiableCollection As SiteMapNodeCollection
    modifiableCollection = New SiteMapNodeCollection(siteNodes)

    ' The MoveNode example method moves a node from position one to
    ' the last position in the collection.
    MoveNode(modifiableCollection)
Else
    MoveNode(siteNodes)
End If

Remarks

This method retrieves immediate child nodes, and all their child nodes, recursively.

See also

• RootNode
• SiteMapNodeCollection