SiteMapNodeCollection.Remove 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.

Removes the specified SiteMapNode object from the collection.

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

public virtual void Remove(
	SiteMapNode value
)

Parameters

value
Type: System.Web.SiteMapNode

The SiteMapNode to remove from the SiteMapNodeCollection.

Exception Condition
ArgumentException

value does not exist in the collection.

ArgumentNullException

value is null.

NotSupportedException

The SiteMapNodeCollection is read-only.

-or-

The SiteMapNodeCollection has a fixed size.

You can test whether a SiteMapNodeCollection collection is read-only by checking the IsReadOnly property.

The Remove method determines equality by calling the Object.Equals method.

The following code example demonstrates how to use the Remove method to remove a SiteMapNode object from a SiteMapNodeCollection collection, and then append the SiteMapNode object to the end of the SiteMapNodeCollection using the Add method. If the SiteMapNodeCollection is read-only, a NotSupportedException exception is caught.


// Move a node from one spot in the list to another.
try {
    Response.Write("Original node order: <BR>");
    foreach (SiteMapNode node in nodes) {
        Response.Write( node.Title + "<BR>");
    }
    SiteMapNode aNode = nodes[1];

    Response.Write("Adding " + aNode.Title + " to the end of the collection.<BR>");
    nodes.Add(aNode);

    Response.Write("Removing " + aNode.Title + " at position 1. <BR>");
    nodes.Remove(nodes[1]);

    Response.Write("New node order: <BR>");
    foreach (SiteMapNode node in nodes) {
        Response.Write( node.Title + "<BR>");
    }
}
catch (NotSupportedException nse) {
    Response.Write("NotSupportedException caught.<BR>");
}

.NET Framework
Available since 2.0
Return to top
Show: