TreeView.CheckedNodes Property
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.
public:
property System::Web::UI::WebControls::TreeNodeCollection ^ CheckedNodes { System::Web::UI::WebControls::TreeNodeCollection ^ get(); };[System.ComponentModel.Browsable(false)]
public System.Web.UI.WebControls.TreeNodeCollection CheckedNodes { get; }[<System.ComponentModel.Browsable(false)>]
member this.CheckedNodes : System.Web.UI.WebControls.TreeNodeCollectionPublic ReadOnly Property CheckedNodes As TreeNodeCollectionProperty Value
A TreeNodeCollection that contains the nodes in the TreeView that display a selected check box.
- Attributes
Examples
The following code example demonstrates how to use the CheckedNodes property to determine which nodes have a selected check box in the TreeView control.
<%@ 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 Button_Click(Object sender, EventArgs e)
{
if(LinksTreeView.CheckedNodes.Count > 0)
{
// Clear the message label.
Message.Text = "You selected: <br /><br />";
// Iterate through the CheckedNodes collection and display the selected nodes.
foreach (TreeNode node in LinksTreeView.CheckedNodes)
{
Message.Text += node.Text + "<br />";
}
}
else
{
Message.Text = "No items selected.";
}
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>TreeView ShowCheckBoxes Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>TreeView ShowCheckBoxes Example</h3>
<!-- Set the ShowCheckBoxes property declaratively. -->
<!-- Because the ShowCheckBoxes property uses a flag -->
<!-- enumeration, you can combine multiple values by -->
<!-- using the bitwise OR operator. In declarative -->
<!-- syntax, this is done using a comma separated -->
<!-- list. -->
<asp:TreeView id="LinksTreeView"
Font-Names= "Arial"
ForeColor="Blue"
ExpandDepth="2"
ShowCheckBoxes="Parent,Leaf"
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"
SelectAction="None">
<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>
<br /><br />
<asp:Button id="Submit"
Text="Select Items"
OnClick="Button_Click"
runat="server"/>
<br /><br />
<asp:Label id="Message"
runat="server"/>
</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 Button_Click(ByVal sender As Object, ByVal e As EventArgs)
If LinksTreeView.CheckedNodes.Count > 0 Then
' Clear the message label.
Message.Text = "You selected: <br /><br />"
' Iterate through the CheckedNodes collection and display the selected nodes.
Dim node As TreeNode
For Each node In LinksTreeView.CheckedNodes
Message.Text &= node.Text & "<br />"
Next
Else
Message.Text = "No items selected."
End If
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>TreeView ShowCheckBoxes Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>TreeView ShowCheckBoxes Example</h3>
<!-- Set the ShowCheckBoxes property declaratively. -->
<!-- Because the ShowCheckBoxes property uses a flag -->
<!-- enumeration, you can combine multiple values by -->
<!-- using the bitwise OR operator. In declarative -->
<!-- syntax, this is done using a comma separated -->
<!-- list. -->
<asp:TreeView id="LinksTreeView"
Font-Names= "Arial"
ForeColor="Blue"
ExpandDepth="2"
ShowCheckBoxes="Parent,Leaf"
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"
SelectAction="None">
<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>
<br /><br />
<asp:Button id="Submit"
Text="Select Items"
OnClick="Button_Click"
runat="server"/>
<br /><br />
<asp:Label id="Message"
runat="server"/>
</form>
</body>
</html>
Remarks
When check boxes are displayed in the TreeView control (by setting the ShowCheckBoxes property to a value other than TreeNodeType.None), use the CheckedNodes property to determine which nodes display a selected check box. This collection is commonly used to iterate through all the nodes that have a selected check box in the tree.
The TreeNodeCheckChanged event is raised when the check boxes of the TreeView control change state between posts to the server. This allows you to provide an event-handling method that performs a custom routine, such as updating a database or the displayed content, whenever this event occurs.
Note
The CheckedNodes collection is populated using a depth-first traversal of the tree structure: each parent node is processed down to its child nodes before the next parent node is populated.
Applies to
See also
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