SiteMapNodeCollection.Remove(SiteMapNode) Method

  • Reference

Definition

Namespace:
System.Web
Assembly:
System.Web.dll

Removes the specified SiteMapNode object from the collection.

public:
 virtual void Remove(System::Web::SiteMapNode ^ value);
public virtual void Remove (System.Web.SiteMapNode value);
abstract member Remove : System.Web.SiteMapNode -> unit
override this.Remove : System.Web.SiteMapNode -> unit
Public Overridable Sub Remove (value As SiteMapNode)

Parameters

value
SiteMapNode

The SiteMapNode to remove from the SiteMapNodeCollection.

Exceptions

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.

Examples

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


' 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

Remarks

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.

Applies to

See also