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

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

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

TreeView.EnableClientScript プロパティ

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

TreeView コントロールがクライアント側のスクリプトを表示して、イベントの展開と折りたたみを処理するかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

<ThemeableAttribute(False)> _
Public Property EnableClientScript As
 Boolean

Visual Basic (使用法)

Dim instance As TreeView
Dim value As Boolean

value = instance.EnableClientScript

instance.EnableClientScript = value

[ThemeableAttribute(false)] 
public bool EnableClientScript { get;
 set; }

C++

[ThemeableAttribute(false)] 
public:
property bool EnableClientScript {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_EnableClientScript ()

/** @property */
public void set_EnableClientScript (boolean
 value)

JScript

public function get EnableClientScript
 () : boolean

public function set EnableClientScript
 (value : boolean)

プロパティ値
互換性のあるブラウザにクライアント側のスクリプトを表示する場合は true。それ以外の場合は false。既定値は true です。

解説

EnableClientScript プロパティを使用して、TreeView コントロールが互換性のあるブラウザにクライアント側のスクリプトを表示して、イベントの展開と折りたたみを処理するかどうかを指定します。このプロパティが true に設定されている場合、互換性のあるブラウザはコードを実行して、クライアント上のノードを展開および折りたたみします。クライアント側のスクリプトが動作する前に、ツリーノードデータを認識する必要があります。クライアントスクリプトを使用すると、ノードが展開また折りたたみされるたびに、サーバーへのポストバックが発生するのを回避できます。

ツリーノードデータがあらかじめわからなくても、PopulateNodesFromClient プロパティも true に設定されている場合には、クライアントからノードにデータを設定できます。この場合、ノードにデータを設定するために、TreeNodePopulate イベントのイベント処理メソッドも指定する必要があります。クライアント側のノードへのデータ設定の詳細については、PopulateNodesFromClient のトピックを参照してください。

メモ
EnableClientScript プロパティが false に設定されている場合、ノードが展開または折りたたみされるたびに、TreeView コントロールがサーバーにポストバックします。

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

このプロパティは、テーマ別またはスタイルシートテーマ別に設定することはできません。詳細については、ThemeableAttribute、ASP.NET のテーマとスキンの概要の各トピックを参照してください。

使用例

このセクションには、2 つのコード例が含まれています。EnableClientScript プロパティを使用して、互換性のあるブラウザでノードを展開および折りたたみするために使用するクライアント側スクリプトを表示する方法を最初のコード例に示します。最初のコード例に対応したサンプル XML データを 2 番目のコード例に示します。

EnableClientScript プロパティを使用して、互換性のあるブラウザでノードを展開および折りたたみするために使用するクライアント側スクリプトを表示する方法を次のコード例に示します。EnableClientScript プロパティが false に設定されている場合、ノードを展開および折りたたみするには、サーバーへのポストが必要です。この例を正常に動作させるには、このコード例の後に示すサンプル XML データを、Book.xml という名前のファイルにコピーする必要があります。

Visual Basic

<%@ Page Language="VB" %>

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