TreeNodeCollection.Remove(TreeNode) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Removes the specified TreeNode object from the TreeNodeCollection object.
public:
void Remove(System::Web::UI::WebControls::TreeNode ^ value);public void Remove (System.Web.UI.WebControls.TreeNode value);member this.Remove : System.Web.UI.WebControls.TreeNode -> unitPublic Sub Remove (value As TreeNode)Parameters
Exceptions
value is null.
Examples
The following example demonstrates how to use the Remove method to programmatically remove a node from the TreeNodeCollection. Notice that the Nodes and ChildNodes properties each return a TreeNodeCollection object.
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
void Page_Load(Object sender, EventArgs e)
{
if (!IsPostBack)
{
// Use the Add and Remove methods to programmatically
// remove the Appendix C node and replace it with a new
// node.
LinksTreeView.Nodes.Remove(LinksTreeView.Nodes[3]);
LinksTreeView.Nodes.Add(new TreeNode("New Appendix C"));
// Use the AddAt and RemoveAt methods to programmatically
// remove the Chapter One node and replace it with a new node.
LinksTreeView.Nodes[0].ChildNodes.RemoveAt(0);
LinksTreeView.Nodes[0].ChildNodes.AddAt(0, new TreeNode("New Chapter One"));
// Use the Clear method to remove all the child nodes of the
// Chapter Two node.
LinksTreeView.Nodes[0].ChildNodes[1].ChildNodes.Clear();
}
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>TreeNodeCollection Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>TreeNodeCollection Example</h3>
<asp:TreeView id="LinksTreeView"
Font-Names= "Arial"
ForeColor="Blue"
runat="server">
<LevelStyles>
<asp:TreeNodeStyle ChildNodesPadding="10"
Font-Bold="true"
Font-Size="12pt"
ForeColor="DarkGreen"/>
<asp:TreeNodeStyle ChildNodesPadding="5"
Font-Bold="true"
Font-Size="10pt"/>
<asp:TreeNodeStyle ChildNodesPadding="5"
Font-UnderLine="true"
Font-Size="10pt"/>
<asp:TreeNodeStyle ChildNodesPadding="10"
Font-Size="8pt"/>
</LevelStyles>
<Nodes>
<asp:TreeNode Text="Table of Contents"
Expanded="true">
<asp:TreeNode Text="Chapter One">
<asp:TreeNode Text="Section 1.0">
<asp:TreeNode Text="Topic 1.0.1"/>
<asp:TreeNode Text="Topic 1.0.2"/>
<asp:TreeNode Text="Topic 1.0.3"/>
</asp:TreeNode>
<asp:TreeNode Text="Section 1.1">
<asp:TreeNode Text="Topic 1.1.1"/>
<asp:TreeNode Text="Topic 1.1.2"/>
<asp:TreeNode Text="Topic 1.1.3"/>
<asp:TreeNode Text="Topic 1.1.4"/>
</asp:TreeNode>
</asp:TreeNode>
<asp:TreeNode Text="Chapter Two">
<asp:TreeNode Text="Section 2.0">
<asp:TreeNode Text="Topic 2.0.1"/>
<asp:TreeNode Text="Topic 2.0.2"/>
</asp:TreeNode>
</asp:TreeNode>
</asp:TreeNode>
<asp:TreeNode Text="Appendix A" />
<asp:TreeNode Text="Appendix B" />
<asp:TreeNode Text="Appendix C" />
</Nodes>
</asp:TreeView>
</form>
</body>
</html>
<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
If Not IsPostBack Then
' Use the Add and Remove methods to programmatically
' remove the Appendix C node and replace it with a new
' node.
LinksTreeView.Nodes.Remove(LinksTreeView.Nodes(3))
LinksTreeView.Nodes.Add(New TreeNode("New Appendix C"))
' Use the AddAt and RemoveAt methods to programmatically
' remove the Chapter One node and replace it with a new node.
LinksTreeView.Nodes(0).ChildNodes.RemoveAt(0)
LinksTreeView.Nodes(0).ChildNodes.AddAt(0, New TreeNode("New Chapter One"))
' Use the Clear method to remove all the child nodes of the
' Chapter Two node.
LinksTreeView.Nodes(0).ChildNodes(1).ChildNodes.Clear()
End If
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>TreeNodeCollection Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>TreeNodeCollection Example</h3>
<asp:TreeView id="LinksTreeView"
Font-Names= "Arial"
ForeColor="Blue"
runat="server">
<LevelStyles>
<asp:TreeNodeStyle ChildNodesPadding="10"
Font-Bold="true"
Font-Size="12pt"
ForeColor="DarkGreen"/>
<asp:TreeNodeStyle ChildNodesPadding="5"
Font-Bold="true"
Font-Size="10pt"/>
<asp:TreeNodeStyle ChildNodesPadding="5"
Font-UnderLine="true"
Font-Size="10pt"/>
<asp:TreeNodeStyle ChildNodesPadding="10"
Font-Size="8pt"/>
</LevelStyles>
<Nodes>
<asp:TreeNode Text="Table of Contents"
Expanded="true">
<asp:TreeNode Text="Chapter One">
<asp:TreeNode Text="Section 1.0">
<asp:TreeNode Text="Topic 1.0.1"/>
<asp:TreeNode Text="Topic 1.0.2"/>
<asp:TreeNode Text="Topic 1.0.3"/>
</asp:TreeNode>
<asp:TreeNode Text="Section 1.1">
<asp:TreeNode Text="Topic 1.1.1"/>
<asp:TreeNode Text="Topic 1.1.2"/>
<asp:TreeNode Text="Topic 1.1.3"/>
<asp:TreeNode Text="Topic 1.1.4"/>
</asp:TreeNode>
</asp:TreeNode>
<asp:TreeNode Text="Chapter Two">
<asp:TreeNode Text="Section 2.0">
<asp:TreeNode Text="Topic 2.0.1"/>
<asp:TreeNode Text="Topic 2.0.2"/>
</asp:TreeNode>
</asp:TreeNode>
</asp:TreeNode>
<asp:TreeNode Text="Appendix A" />
<asp:TreeNode Text="Appendix B" />
<asp:TreeNode Text="Appendix C" />
</Nodes>
</asp:TreeView>
</form>
</body>
</html>
Remarks
Use the Remove method to remove the specified node from the collection. All items that follow that node are then moved up to fill in the vacant position. The indexes of the moved items are also updated.
Note
The TreeNodeCollection can contain null references (Nothing in Visual Basic), as well as duplicate TreeNode objects.
As an alternative, you can remove a node at a specific index by using the RemoveAt method. You can also remove every node in the collection by using the Clear method.
Applies to
See also
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for