This documentation is archived and is not being maintained.

TreeNode.ShowCheckBox Property

Note: This property is new in the .NET Framework version 2.0.

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 Nullable<bool> ShowCheckBox { get; set; }
/** @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>)

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.

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.


<%@ Page Language="C#" %>

<script runat="server">

  void Data_Bound(Object sender, TreeNodeEventArgs e)
  {

    // Determine the depth of a node as it is bound to data.
    // If the depth is 1, show a check box.
    if(e.Node.Depth == 1)
    {

      e.Node.ShowCheckBox = true;

    }
    else
    {

      e.Node.ShowCheckBox = false;

    }

  }

</script>

<html>
  <body>
    <form runat="server">
    
      <h3>TreeNode ShowCheckBox Example</h3>
    
      <asp:TreeView id="BookTreeView" 
         DataSourceID="BookXmlDataSource"
         OnTreeNodeDataBound="Data_Bound"
         ShowCheckBoxes="None"
         InitialExpandDepth="2"  
         runat="server">
         
        <DataBindings>
          <asp:TreeNodeBinding DataMember="Book" TextField="Title"/>
          <asp:TreeNodeBinding DataMember="Chapter" TextField="Heading"/>
          <asp:TreeNodeBinding DataMember="Section" TextField="Heading"/>
        </DataBindings>
         
      </asp:TreeView>

      <asp:XmlDataSource id="BookXmlDataSource"  
         DataFile="Book.xml"
         runat="server">
      </asp:XmlDataSource>
    
    </form>
  </body>
</html>


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 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: