TreeNode.ShowCheckBox Property

Gets or sets a value that indicates whether a check box is displayed next to the node.

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

public:
property Nullable<bool> ShowCheckBox {
	Nullable<bool> get ();
	void set (Nullable<bool> value);
}
/** @property */
public Nullable<boolean> get_ShowCheckBox ()

/** @property */
public void set_ShowCheckBox (Nullable<boolean> value)

public function get ShowCheckBox () : Nullable<boolean>

public function set ShowCheckBox (value : Nullable<boolean>)

Not applicable.

Property Value

true to display the check box; otherwise, false.

The TreeView control allows you to display a check box next to a node's image. Use the ShowCheckBox property to show or hide the check box for the current node.

Although the ShowCheckBox property can be used to display check boxes, it is more common to use the TreeView.ShowCheckBoxes property of the TreeView control. The TreeView.ShowCheckBoxes property, however, affects every node type specified by the property; therefore, the TreeNode.ShowCheckBox property is often used to override that setting for an individual node.

Since the TreeView.ShowCheckBoxes property is a tri-state property, the following C# code snippet causes a compile error:

protected void TreeView1_SelectedNodeChanged(object sender, EventArgs e)
{
if (TreeView1.Nodes[0].Expanded)
{
// some work here 
}
}

While VB.Net implicitly casts the Boolean value to a NullableBoolean, C# does not. Therefore, it is a best practice to explicitly check the state of the property. For example, the following code examples in Visual Basic and C# explicitly test the value of the Expanded property.

The following Visual Basic code example explicitly tests the value of the Expanded property. This example tests if the Expanded property is set to True; therefore Nothing and False fall through the If statement.

If TreeView1.Nodes(0).Expanded = True Then 'some work hereEnd IF

This C# code example explicitly tests the value of the Expanded property. This example tests if the Expanded property is set to True; therefore Null and False fall through the If statement.

if( TreeView1.Nodes[0].Expanded == true ) { //some work here}

The value of this property is stored in view state.

The following code example demonstrates how to use the ShowCheckBox property to programmatically show and hide the check box for a node in the TreeView control. For this example to work correctly, you must copy the sample XML data below to a file named Book.xml.

No code example is currently available or this language may not be supported.

The following code is sample XML data for the previous example.

<Book Title="Book Title">
    <Chapter Heading="Chapter 1">
        <Section Heading="Section 1">
        </Section>
        <Section Heading="Section 2">
        </Section>
    </Chapter>
    <Chapter Heading="Chapter 2">
        <Section Heading="Section 1">
        </Section>
    </Chapter>
</Book>

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: