GridView.AutoGenerateSelectButton プロパティ

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

GridView.AutoGenerateSelectButton プロパティ

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

データ行ごとに Select ボタンを持つ CommandField フィールド列を自動的に GridView コントロールに追加するかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Property
 AutoGenerateSelectButton As Boolean

Visual Basic (使用法)

Dim instance As GridView
Dim value As Boolean

value = instance.AutoGenerateSelectButton

instance.AutoGenerateSelectButton = value

C#

public virtual bool AutoGenerateSelectButton
 { get; set; }

C++

public:
virtual property bool AutoGenerateSelectButton {
    bool get ();
    void set (bool value);
}

J#

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

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

JScript

public function get AutoGenerateSelectButton
 () : boolean

public function set AutoGenerateSelectButton
 (value : boolean)

プロパティ値
データ行ごとに Select ボタンを持つ CommandField フィールド列を自動的に追加する場合は true。それ以外の場合は false。既定値は false です。

解説

AutoGenerateSelectButton プロパティが true に設定されている場合、データ行ごとに Select ボタンを持つ (CommandField オブジェクトで表される) 列が自動的に GridView コントロールに追加されます。行の Select ボタンをクリックすると、コントロール内のその行が選択され、SelectedIndex プロパティが行のインデックスに設定されます。選択されている行を表す GridViewRow オブジェクトを取得するには、SelectedRow プロパティを使用します。SelectedValue プロパティを使用して、選択されているレコードの主キー値を取得することもできます。SelectedValue プロパティには、DataKeyNames プロパティで指定されたキー フィールドの値が格納されます。

メモ
SelectedIndex プロパティを設定して、プログラムによって行を選択できます。行の選択をキャンセルするには、SelectedIndex プロパティを -1 に設定します。

選択されている行の外観は、SelectedRowStyle プロパティを使用して制御できます。通常、共通設定には、カスタムの背景色、前景色、およびフォントのプロパティが含まれます。

GridView コントロールには、行が選択されるときにカスタム アクションを実行するために使用できる複数のイベントが用意されています。使用できるイベントの一覧を次の表に示します。

イベント	説明
SelectedIndexChanged	行の Select ボタンがクリックされた場合に、GridView コントロールが選択操作を処理した後に発生します。このイベントは、コントロールの行が選択された後にタスクを実行する場合によく使用されます。
SelectedIndexChanging	行の Select ボタンがクリックされた場合に、GridView コントロールが選択操作を処理する前に発生します。このイベントは、選択操作をキャンセルする場合によく使用されます。

使用例

AutoGenerateSelectButton プロパティを使用して、GridView コントロールの自動選択機能を有効にする方法を次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomersGridView_SelectedIndexChanged(ByVal
 sender As Object, ByVal
 e As EventArgs)
        
    ' Get the currently selected row using the SelectedRow property.
    Dim row As GridViewRow = CustomersGridView.SelectedRow
        
    ' Display the company name from the selected row.
    ' In this example, the third column (index 2) contains
    ' the company name.
    Message.Text = "You selected " & row.Cells(2).Text
 & "."
    
  End Sub

  Sub CustomersGridView_SelectedIndexChanging(ByVal
 sender As Object, ByVal
 e As GridViewSelectEventArgs)
        
    ' Get the currently selected row. Because the SelectedIndexChanging
 event
    ' occurs before the select operation in the GridView control, the
    ' SelectedRow property cannot be used. Instead, use the Rows collection
    ' and the NewSelectedIndex property of the e argument passed to
 this 
    ' event handler.
    Dim row As GridViewRow = CustomersGridView.Rows(e.NewSelectedIndex)

    ' You can cancel the select operation by using the Cancel
    ' property. For this example, if the user selects a customer with
 
    ' the ID "ANATR", the select operation is canceled and
 an error message
    ' is displayed.
    If row.Cells(1).Text = "ANATR"
 Then
 
      e.Cancel = True
      Message.Text = "You cannot select " + row.Cells(2).Text
 & "."
      
    End If
    
  End Sub

</script>

<html>
  <body>
    <form runat="server">
        
     <h3>GridView Select Example</h3>

     <asp:gridview id="CustomersGridView" 
       datasourceid="CustomersSource" 
       autogeneratecolumns="true"
       autogenerateselectbutton="true"
       allowpaging="true" 
       selectedindex="0"
       onselectedindexchanged="CustomersGridView_SelectedIndexChanged"
       onselectedindexchanging="CustomersGridView_SelectedIndexChanging"
   
       runat="server">
                
       <selectedrowstyle backcolor="LightCyan"
         forecolor="DarkBlue"
         font-bold="true"/>  
                
     </asp:gridview>
            
      <br/>
            
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
            
      <!-- This example uses Microsoft SQL Server and connects
  -->
      <!-- to the Northwind sample database. Use an ASP.NET
     -->
      <!-- expression to retrieve the connection string
 value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address],
 [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
            
    </form>
  </body>
</html>

C#

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

<script runat="server">

  void CustomersGridView_SelectedIndexChanged(Object sender, EventArgs
 e)
  {
    
    // Get the currently selected row using the SelectedRow property.
    GridViewRow row = CustomersGridView.SelectedRow;
        
    // Display the company name from the selected row.
    // In this example, the third column (index 2) contains
    // the company name.
    Message.Text = "You selected " + row.Cells[2].Text + ".";
    
  }

  void CustomersGridView_SelectedIndexChanging(Object sender,
 GridViewSelectEventArgs e)
  {
        
    // Get the currently selected row. Because the SelectedIndexChanging
 event
    // occurs before the select operation in the GridView control, the
    // SelectedRow property cannot be used. Instead, use the Rows collection
    // and the NewSelectedIndex property of the e argument passed to
 this 
    // event handler.
    GridViewRow row = CustomersGridView.Rows[e.NewSelectedIndex];

    // You can cancel the select operation by using the Cancel
    // property. For this example, if the user selects a customer with
 
    // the ID "ANATR", the select operation is canceled and
 an error message
    // is displayed.
    if (row.Cells[1].Text == "ANATR")
    {
        
      e.Cancel = true;
      Message.Text = "You cannot select " + row.Cells[2].Text + ".";
        
    }
    
  }

</script>

<html>
  <body>
    <form runat="server">
        
     <h3>GridView Select Example</h3>

     <asp:gridview id="CustomersGridView" 
       datasourceid="CustomersSource" 
       autogeneratecolumns="true"
       autogenerateselectbutton="true"
       allowpaging="true" 
       selectedindex="0"
       onselectedindexchanged="CustomersGridView_SelectedIndexChanged"
       onselectedindexchanging="CustomersGridView_SelectedIndexChanging"
   
       runat="server">
                
       <selectedrowstyle backcolor="LightCyan"
         forecolor="DarkBlue"
         font-bold="true"/>  
                
     </asp:gridview>
            
      <br/>
            
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value
   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City],
 [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
            
    </form>
  </body>
</html>

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
GridView クラス
GridView メンバ
System.Web.UI.WebControls 名前空間
CommandField クラス
GridViewRow
GridView.AutoGenerateDeleteButton プロパティ
GridView.AutoGenerateEditButton プロパティ
GridView.AutoGenerateColumns プロパティ
DataKeyNames
SelectedIndex
SelectedRow
SelectedRowStyle
SelectedValue
SelectedIndexChanged
SelectedIndexChanging