SiteMapNodeCollection.Remove Method (SiteMapNode)

 

Removes the specified SiteMapNode object from the collection.

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

Public Overridable Sub Remove (
	value As SiteMapNode
)

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>")
    Dim node As SiteMapNode
    For Each node In nodes
        Response.Write( node.Title & "<BR>")
    Next

    Dim aNode As SiteMapNode = 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>")

    For Each node In nodes
        Response.Write( node.Title & "<BR>")
    Next

Catch nse As NotSupportedException
    Response.Write("NotSupportedException caught.<BR>")
End Try

.NET Framework
Available since 2.0
Return to top
Show: