This documentation is archived and is not being maintained.

SiteMapNodeCollection.Remove Method

Note: This method is new in the .NET Framework version 2.0.

Removes the specified SiteMapNode object from the collection.

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

public virtual void Remove (
	SiteMapNode value
)
public void Remove (
	SiteMapNode value
)
public function Remove (
	value : SiteMapNode
)

Parameters

value

The SiteMapNode to remove from the SiteMapNodeCollection.

Exception typeCondition

ArgumentException

value does not exist in the collection.

ArgumentNullException

value is a null reference (Nothing in Visual Basic).

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>");
}

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: