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

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

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

TreeView.DataBindings プロパティ

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

データ項目とそのバインド先のノードとの間の関係を定義する TreeNodeBinding オブジェクトのコレクションを取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 DataBindings As TreeNodeBindingCollection

Visual Basic (使用法)

Dim instance As TreeView
Dim value As TreeNodeBindingCollection

value = instance.DataBindings

public TreeNodeBindingCollection DataBindings { get;
 }

C++

public:
property TreeNodeBindingCollection^ DataBindings {
    TreeNodeBindingCollection^ get ();
}

/** @property */
public TreeNodeBindingCollection get_DataBindings ()

JScript

public function get DataBindings
 () : TreeNodeBindingCollection

プロパティ値
データ項目とそのバインド先のノードとの間の関係を表す TreeNodeBindingCollection。

解説

DataBindings コレクションには、データ項目とそのバインド先のノードとの間の関係を定義する TreeNodeBinding オブジェクトが含まれています。複数の属性を持つ XML 要素などのように、各データ項目に複数のプロパティが含まれているデータソースにバインドする場合、ノードにはデータ項目の ToString メソッドから返される値が既定で表示されます。XML 要素の場合、ノードには要素名が表示されます。これはメニューツリーの基になる構造体を示す以外はあまり用途はありません。ツリーノードのバインディングを指定することにより、ノードを特定のデータ項目のプロパティにバインドできます。

データ項目とノードの間の関係を定義する場合、バインディング基準と TreeNode オブジェクトのプロパティにバインドされる値の両方を指定する必要があります。基準は、データ項目をノードにバインドするタイミングを示します。基準は、ノードの深さ、データメンバ、またはその両方で指定できます。ノードの深さはバインドされるノードレベルを指定します。たとえば、ノードの深さに 0 を指定すると、ツリー構造のレベル 0 にあるすべてのノードが、ツリーノードのバインディングを使用してバインドされます。データメンバは、基になるデータソースのデータ項目の型を指定します。ただし、データソースによっては異なる情報を表している場合があります。たとえば、XML 要素のデータメンバは、要素名を指定します。

互いに競合する複数の TreeNodeBinding オブジェクトが定義されている場合、TreeView コントロールは次の優先順位でツリーノードのバインディングを適用します。

深さとデータメンバの両方を定義する TreeNodeBinding オブジェクト。
深さだけを定義する TreeNodeBinding オブジェクト。
データメンバだけを定義する TreeNodeBinding オブジェクト。
深さもデータメンバも定義しない TreeNodeBinding オブジェクト。

同じ優先順位の基準を満たす複数のバインディングが指定されている場合は、コレクション内の最初のバインディングが適用されます。

バインディング基準を確立したら、バインド可能な TreeNode オブジェクトのプロパティを値にバインドできます。データ項目の属性またはフィールドにバインドするか、または静的な値を表示できます。TreeNode オブジェクトのプロパティを値にバインドする方法の詳細については、TreeNodeBinding のトピックを参照してください。

DataBindings コレクションはプログラムにより設定できますが、通常は宣言によって設定されます。ツリーノードのバインディングを指定するには、まず TreeView コントロールの開始タグと終了タグの間に <DataBindings> の開始タグと終了タグを入れ子にします。次に、指定するツリーノードのバインディングごとに、<DataBindings> の開始タグと終了タグの間に <asp:TreeNodeBinding> 要素を入れます。

TreeView コントロールの AutoGenerateDataBindings プロパティを true に設定してデータバインディングを作成した場合、作成されるバインディングの PopulateOnDemand プロパティは true に設定されます。宣言によって作成されるデータバインディングの PopulateOnDemand プロパティは、false に設定されます。宣言構文を使用すると、個々のデータバインディングの動作を制御できます。

使用例

このセクションには、2 つのコード例が含まれています。DataBindings コレクションを使用して、データ項目とそのバインド先のノードとの間の関係を定義する方法を最初のコード例に示します。最初のコード例に対応したサンプル XML データを 2 番目のコード例に示します。

DataBindings コレクションを使用して、データ項目とそのバインド先のノードとの間の関係を定義する方法を次のコード例に示します。この例を正常に動作させるには、このコード例の後に示すサンプル XML データを、Book.xml という名前のファイルにコピーする必要があります。この例では、バインディングの DataMember プロパティだけを指定します。Depth プロパティも指定すると、効率が少し向上する可能性があります。

Visual Basic

<%@ Page Language="VB" %>

<html>
  <body>
    <form runat="server">
    
      <h3>TreeView XML Data Binding Example</h3>
    
      <asp:TreeView id="BookTreeView" 
        DataSourceID=BookXmlDataSource
        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>

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

<html>
  <body>
    <form runat="server">
    
      <h3>TreeView XML Data Binding Example</h3>
    
      <asp:TreeView id="BookTreeView" 
        DataSourceID=BookXmlDataSource
        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>

前の例に対応したサンプル 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>
</Book>