TreeNodeBinding.ShowCheckBox プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

TreeNodeBinding.ShowCheckBox プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

TreeNodeBinding オブジェクトが適用されるノードの横にチェックボックスを表示するかどうかを示す値を取得または設定します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Property ShowCheckBox As
 Nullable(Of Boolean)

Visual Basic (使用法)

Dim instance As TreeNodeBinding
Dim value As Nullable(Of
 Boolean)

value = instance.ShowCheckBox

instance.ShowCheckBox = value

public Nullable<bool> ShowCheckBox {
 get; set; }

C++

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)

JScript

public function get ShowCheckBox
 () : Nullable<boolean>

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

プロパティ値
TreeNodeBinding オブジェクトが適用されるノードの横にチェックボックスを表示する場合は true。それ以外の場合は false。既定値は false です。

解説

TreeView コントロールでマルチノードの選択をサポートするために、ノード内のイメージの横にチェックボックスを表示できます。TreeView コントロールをデータソースにバインドする場合、TreeNode オブジェクトの ShowCheckBox プロパティにバインドする値は、ShowCheckBox プロパティで指定します。このバインディングの関係は、TreeNodeBinding オブジェクトが適用されるすべての TreeNode オブジェクトに影響します。ShowCheckBox プロパティを使用して、ノードのチェックボックスを表示または非表示にします。

メモ
ShowCheckBox プロパティを使用してチェックボックスを表示できますが、TreeView コントロールの ShowCheckBoxes プロパティを使用する方がより一般的です。ただし、ShowCheckBoxes プロパティは、このプロパティが指定するすべてのノード型に影響を与えるため、TreeNodeBinding オブジェクトが適用されるノードの設定をオーバーライドするには、ShowCheckBox プロパティがよく使用されます。ShowCheckBox プロパティは、各ノードの ShowCheckBox プロパティを直接設定することにより、選択的にオーバーライドできます。

メモ

ShowCheckBox プロパティを使用してチェックボックスを表示できますが、TreeView コントロールの ShowCheckBoxes プロパティを使用する方がより一般的です。ただし、ShowCheckBoxes プロパティは、このプロパティが指定するすべてのノード型に影響を与えるため、TreeNodeBinding オブジェクトが適用されるノードの設定をオーバーライドするには、ShowCheckBox プロパティがよく使用されます。ShowCheckBox プロパティは、各ノードの ShowCheckBox プロパティを直接設定することにより、選択的にオーバーライドできます。

このプロパティの値はビューステートに格納されます。

使用例

このセクションには、2 つのコード例が含まれています。ShowCheckBox プロパティを使用して、ノードにチェックボックスを表示するかどうかを指定する方法を最初のコード例に示します。最初のコード例に対応したサンプル XML データを 2 番目のコード例に示します。

ShowCheckBox プロパティを使用して、ノードにチェックボックスを表示するかどうかを指定する方法を次の例に示します。この例を正常に動作させるには、このコード例の後に示すサンプル XML データを、Book.xml という名前のファイルにコピーする必要があります。

Visual Basic

<%@ Page Language="VB" %>

<script runat="server">

  Sub BookTreeView_CheckChanged(sender As Object,
 e As TreeNodeEventArgs)
   
    ' Display the nodes that have their check box selected.
    Message.Text = "You selected the following check boxes: "
   
    Dim node As TreeNode
    
    For Each node in BookTreeView.CheckedNodes
    
      Message.Text &= node.Text & " "
    
    Next
    
  End Sub

</script>

<html>
  <body>
    <form runat="server">
    
      <h3>TreeNodeBinding ShowCheckBox Example</h3>
    
      <asp:treeview id="BookTreeView" 
         datasourceid="BookXmlDataSource"
         initialexpanddepth="2"
         oncheckchanged="BookTreeView_CheckChanged"
   
         runat="server">
         
        <DataBindings>
          <asp:TreeNodeBinding DataMember="Book"
 
            TextField="Title"/>
          <asp:TreeNodeBinding DataMember="Chapter"
 
            TextField="Heading"
            ShowCheckBox="True"/>
        </DataBindings>
         
      </asp:treeview>
      
      <asp:xmldatasource id="BookXmlDataSource"
  
         datafile="Book.xml"
         runat="server">
      </asp:xmldatasource>
      
      <br/><br/>
      
      <asp:label id="Message"
        runat="server"/>
      
      <hr/>
      
      <asp:button id="SubmitButton"
        text="Submit"
        runat="server"/>
    
    </form>
  </body>
</html>

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

<script runat="server">

  void BookTreeView_CheckChanged(Object sender, TreeNodeEventArgs
 e)
  {
   
    // Display the nodes that have their check box selected.
    Message.Text = "You selected the following check boxes: ";
   
    foreach(TreeNode node in BookTreeView.CheckedNodes)
    {
    
      Message.Text += node.Text + " ";
    
    }
    
  }

</script>

<html>
  <body>
    <form runat="server">
    
      <h3>TreeNodeBinding ShowCheckBox Example</h3>
    
      <asp:treeview id="BookTreeView" 
         datasourceid="BookXmlDataSource"
         initialexpanddepth="2"
         oncheckchanged="BookTreeView_CheckChanged"   
         runat="server">
         
        <DataBindings>
          <asp:TreeNodeBinding DataMember="Book" 
            TextField="Title"/>
          <asp:TreeNodeBinding DataMember="Chapter" 
            TextField="Heading"
            ShowCheckBox="True"/>
        </DataBindings>
         
      </asp:treeview>
      
      <asp:xmldatasource id="BookXmlDataSource"  
         datafile="Book.xml"
         runat="server">
      </asp:xmldatasource>
      
      <br/><br/>
      
      <asp:label id="Message"
        runat="server"/>
      
      <hr/>
      
      <asp:button id="SubmitButton"
        Text="Submit"
        runat="server"/>
    
    </form>
  </body>
</html>

前のコード例に対応したサンプル XML データを次のコード例に示します。

<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>
    <Appendix Heading="Appendix A">
    </Appendix>
</Book>