ButtonColumn

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

ButtonColumn クラス

ユーザー定義のボタンを含む DataGrid コントロールの列型。

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

Visual Basic (宣言)

Public Class ButtonColumn
    Inherits DataGridColumn

Visual Basic (使用法)

Dim instance As ButtonColumn

C#

public class ButtonColumn : DataGridColumn

C++

public ref class ButtonColumn : public
 DataGridColumn

J#

public class ButtonColumn extends DataGridColumn

JScript

public class ButtonColumn extends
 DataGridColumn

解説

DataGrid コントロールの ButtonColumn クラスを使用して、DataGrid コントロールの各行に対応するボタンを作成します。Text プロパティを設定して、ボタンに表示するキャプションを指定します。Text プロパティを設定した場合は、ButtonColumn オブジェクト内のすべてのボタンで同じキャプションが共有されます。ButtonColumn ボタンをデータ ソースのフィールドにバインドしても同じように設定できます。この場合、各ボタンに異なるキャプションを表示できます。テキスト キャプションには、指定フィールドの値が使用されます。ButtonColumn をデータ ソースのフィールドにバインドするには、DataTextField プロパティを設定します。

DataTextField プロパティを書式指定文字列で設定すると、ボタンに表示するキャプションの書式を指定できます。

ButtonColumn 内のボタンをクリックすると、ItemCommand イベントが発生します。ItemCommand イベントのイベント ハンドラを作成すると、ボタンがクリックされたときに実行するアクションをプログラムによって制御できます。

既定では、ButtonColumn 内のボタンがクリックされたときにページ検証が実行されません。ページ検証は、ページ上にある検証コントロールに関連付けられたすべての入力コントロールが、その検証コントロールによって指定されている検証規則に準拠しているかどうかを判断します。ボタンがクリックされたときにページ検証を実行するには、CausesValidation プロパティを true に設定します。

使用例

DataGrid コントロールで ButtonColumn クラスを使用して [追加] ボタンを作成するコード例を次に示します。

Visual Basic

Private Sub Page_Init(sender As
 Object, e As EventArgs)
    
    ' Create dynamic column to add to Columns collection.
    Dim AddColumn As New
 ButtonColumn()
    AddColumn.HeaderText = "Add Item"
    AddColumn.Text = "Add"
    AddColumn.CommandName = "Add"
    AddColumn.ButtonType = ButtonColumnType.PushButton

    
    ' Add column to Columns collection.
    ItemsGrid.Columns.AddAt(2, AddColumn)
End Sub 'Page_Init 

C#

private void Page_Init(Object sender, EventArgs
 e) 
{

   // Create dynamic column to add to Columns collection.
   ButtonColumn AddColumn = new ButtonColumn();
   AddColumn.HeaderText="Add Item"; 
   AddColumn.Text="Add";
   AddColumn.CommandName="Add";
   AddColumn.ButtonType = ButtonColumnType.PushButton;


   // Add column to Columns collection.
   ItemsGrid.Columns.AddAt(2, AddColumn);

}
   

J#

private void Page_Init(Object sender, EventArgs
 e)
{
    // Create dynamic column to add to Columns collection.
    ButtonColumn addColumn = new ButtonColumn();
    addColumn.set_HeaderText("Add Item");
    addColumn.set_Text("Add");
    addColumn.set_CommandName("Add");
    addColumn.set_ButtonType(ButtonColumnType.PushButton);
 

    // Add column to Columns collection.
    itemsGrid.get_Columns().AddAt(2, addColumn);
} //Page_Init

JScript

private function Page_Init(sender : Object,
 e : EventArgs) 
{

   // Create dynamic column to add to Columns collection.
   var AddColumn : ButtonColumn = new ButtonColumn();
   AddColumn.HeaderText="Add Item"; 
   AddColumn.Text="Add";
   AddColumn.CommandName="Add";
   AddColumn.ButtonType = ButtonColumnType.PushButton;


   // Add column to Columns collection.
   ItemsGrid.Columns.AddAt(2, AddColumn);

}
   

継承階層

System.Object
   System.Web.UI.WebControls.DataGridColumn
    System.Web.UI.WebControls.ButtonColumn

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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、1.1、1.0

参照

関連項目
ButtonColumn メンバ
System.Web.UI.WebControls 名前空間
DataGrid
DataGridColumn
BoundColumn クラス
EditCommandColumn
HyperLinkColumn
TemplateColumn
Button クラス
LinkButton

ButtonColumn コンストラクタ

ButtonColumn クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New ButtonColumn

C#

public ButtonColumn ()

C++

public:
ButtonColumn ()

J#

public ButtonColumn ()

JScript

public function ButtonColumn ()

解説

ButtonColumn コンストラクタを使用して、ButtonColumn クラスの新しいインスタンスを作成し、初期化します。

使用例

ButtonColumn クラスの新しいインスタンスを作成し初期化して、Columns コレクションに追加する方法を次のコード例に示します。

Visual Basic

Private Sub Page_Init(sender As
 Object, e As EventArgs)
    
    ' Create dynamic column to add to Columns collection.
    Dim AddColumn As New
 ButtonColumn()
    AddColumn.HeaderText = "Add Item"
    AddColumn.Text = "Add"
    AddColumn.CommandName = "Add"
    AddColumn.ButtonType = ButtonColumnType.PushButton

    
    ' Add column to Columns collection.
    ItemsGrid.Columns.AddAt(2, AddColumn)
End Sub 'Page_Init 

C#

private void Page_Init(Object sender, EventArgs
 e) 
{

   // Create dynamic column to add to Columns collection.
   ButtonColumn AddColumn = new ButtonColumn();
   AddColumn.HeaderText="Add Item"; 
   AddColumn.Text="Add";
   AddColumn.CommandName="Add";
   AddColumn.ButtonType = ButtonColumnType.PushButton;


   // Add column to Columns collection.
   ItemsGrid.Columns.AddAt(2, AddColumn);

}
   

J#

private void Page_Init(Object sender, EventArgs
 e)
{
    // Create dynamic column to add to Columns collection.
    ButtonColumn addColumn = new ButtonColumn();
    addColumn.set_HeaderText("Add Item");
    addColumn.set_Text("Add");
    addColumn.set_CommandName("Add");
    addColumn.set_ButtonType(ButtonColumnType.PushButton);
 

    // Add column to Columns collection.
    itemsGrid.get_Columns().AddAt(2, addColumn);
} //Page_Init

JScript

private function Page_Init(sender : Object,
 e : EventArgs) 
{

   // Create dynamic column to add to Columns collection.
   var AddColumn : ButtonColumn = new ButtonColumn();
   AddColumn.HeaderText="Add Item"; 
   AddColumn.Text="Add";
   AddColumn.CommandName="Add";
   AddColumn.ButtonType = ButtonColumnType.PushButton;


   // Add column to Columns collection.
   ItemsGrid.Columns.AddAt(2, AddColumn);

}
   

プラットフォーム

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、1.1、1.0

参照

関連項目
ButtonColumn クラス
ButtonColumn メンバ
System.Web.UI.WebControls 名前空間
Columns

ButtonColumn プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	ButtonType	ButtonColumn オブジェクトに表示するボタンの種類を取得または設定します。
	CausesValidation	ButtonColumn オブジェクトのボタンがクリックされたときに検証を実行するかどうかを示す値を取得または設定します。
	CommandName	System.Web.UI.WebControls.ButtonColumn オブジェクトのボタンがクリックされたときに実行するコマンドを表す文字列を取得または設定します。
	DataTextField	ButtonColumn オブジェクトにバインドするデータ ソースのフィールド名を取得または設定します。
	DataTextFormatString	各ボタンのキャプションの表示形式を指定する文字列を取得または設定します。
	FooterStyle	列のフッター セクションのスタイル プロパティを取得します。 ( DataGridColumn から継承されます。)
	FooterText	列のフッター セクションに表示されるテキストを取得または設定します。 ( DataGridColumn から継承されます。)
	HeaderImageUrl	列のヘッダー セクションに表示するイメージの位置を取得または設定します。 ( DataGridColumn から継承されます。)
	HeaderStyle	列のヘッダー セクションのスタイル プロパティを取得します。 ( DataGridColumn から継承されます。)
	HeaderText	列のヘッダー セクションに表示されるテキストを取得または設定します。 ( DataGridColumn から継承されます。)
	ItemStyle	列の項目セルのスタイル プロパティを取得します。 ( DataGridColumn から継承されます。)
	SortExpression	並べ替えのために列が選択された場合に、OnSortCommand メソッドに渡されるフィールドの名前または式を、取得または設定します。 ( DataGridColumn から継承されます。)
	Text	ButtonColumn オブジェクトのボタンに表示するキャプションを取得または設定します。
	ValidationGroup	ButtonColumn オブジェクトがサーバーにポストバックされるときに検証が発生する検証コントロールのグループを取得または設定します。
	Visible	DataGrid コントロールに列を表示するかどうかを示す値を取得または設定します。 ( DataGridColumn から継承されます。)

プロテクト プロパティ

	名前	説明
	DesignMode	列がデザイン モードかどうかを示す値を取得します。 ( DataGridColumn から継承されます。)
	IsTrackingViewState	DataGridColumn オブジェクトが状態を保存するようにマークされているかどうかを判断する値を取得します。 ( DataGridColumn から継承されます。)
	Owner	列がメンバとして含まれている DataGrid コントロールを取得します。 ( DataGridColumn から継承されます。)
	ViewState	DataGridColumn クラスから派生した列がそのプロパティを格納できるようにする System.Web.UI.StateBag オブジェクトを取得します。 ( DataGridColumn から継承されます。)

参照

関連項目

ButtonColumn クラス
System.Web.UI.WebControls 名前空間
DataGrid
DataGridColumn
BoundColumn クラス
EditCommandColumn
HyperLinkColumn
TemplateColumn
Button クラス
LinkButton

ButtonColumn メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	Initialize	オーバーライドされます。 ButtonColumn オブジェクトを初期状態にリセットします。
	InitializeCell	オーバーライドされます。 ButtonColumn オブジェクト内のセルをリセットして、初期状態にします。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	列の文字列形式を返します。 ( DataGridColumn から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	FormatDataTextValue	指定された値を DataTextFormatString プロパティで示されている書式に変換します。
	LoadViewState	DataGridColumn オブジェクトの状態を読み込みます。 ( DataGridColumn から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnColumnChanged	DataGridDesigner.OnColumnsChanged メソッドを呼び出します。 ( DataGridColumn から継承されます。)
	SaveViewState	DataGridColumn オブジェクトの現在の状態を保存します。 ( DataGridColumn から継承されます。)
	TrackViewState	サーバー コントロールにビューステートの変更を追跡させ、サーバー コントロールの System.Web.UI.StateBag オブジェクトに変更を格納できるようにします。 ( DataGridColumn から継承されます。)

参照

関連項目

ButtonColumn クラス
System.Web.UI.WebControls 名前空間
DataGrid
DataGridColumn
BoundColumn クラス
EditCommandColumn
HyperLinkColumn
TemplateColumn
Button クラス
LinkButton

ButtonColumn メンバ

ユーザー定義のボタンを含む DataGrid コントロールの列型。

ButtonColumn データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	ButtonColumn	ButtonColumn クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	ButtonType	ButtonColumn オブジェクトに表示するボタンの種類を取得または設定します。
	CausesValidation	ButtonColumn オブジェクトのボタンがクリックされたときに検証を実行するかどうかを示す値を取得または設定します。
	CommandName	System.Web.UI.WebControls.ButtonColumn オブジェクトのボタンがクリックされたときに実行するコマンドを表す文字列を取得または設定します。
	DataTextField	ButtonColumn オブジェクトにバインドするデータ ソースのフィールド名を取得または設定します。
	DataTextFormatString	各ボタンのキャプションの表示形式を指定する文字列を取得または設定します。
	FooterStyle	列のフッター セクションのスタイル プロパティを取得します。(DataGridColumn から継承されます。)
	FooterText	列のフッター セクションに表示されるテキストを取得または設定します。(DataGridColumn から継承されます。)
	HeaderImageUrl	列のヘッダー セクションに表示するイメージの位置を取得または設定します。(DataGridColumn から継承されます。)
	HeaderStyle	列のヘッダー セクションのスタイル プロパティを取得します。(DataGridColumn から継承されます。)
	HeaderText	列のヘッダー セクションに表示されるテキストを取得または設定します。(DataGridColumn から継承されます。)
	ItemStyle	列の項目セルのスタイル プロパティを取得します。(DataGridColumn から継承されます。)
	SortExpression	並べ替えのために列が選択された場合に、OnSortCommand メソッドに渡されるフィールドの名前または式を、取得または設定します。(DataGridColumn から継承されます。)
	Text	ButtonColumn オブジェクトのボタンに表示するキャプションを取得または設定します。
	ValidationGroup	ButtonColumn オブジェクトがサーバーにポストバックされるときに検証が発生する検証コントロールのグループを取得または設定します。
	Visible	DataGrid コントロールに列を表示するかどうかを示す値を取得または設定します。(DataGridColumn から継承されます。)

プロテクト プロパティ

	名前	説明
	DesignMode	列がデザイン モードかどうかを示す値を取得します。(DataGridColumn から継承されます。)
	IsTrackingViewState	DataGridColumn オブジェクトが状態を保存するようにマークされているかどうかを判断する値を取得します。(DataGridColumn から継承されます。)
	Owner	列がメンバとして含まれている DataGrid コントロールを取得します。(DataGridColumn から継承されます。)
	ViewState	DataGridColumn クラスから派生した列がそのプロパティを格納できるようにする System.Web.UI.StateBag オブジェクトを取得します。(DataGridColumn から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	Initialize	オーバーライドされます。 ButtonColumn オブジェクトを初期状態にリセットします。
	InitializeCell	オーバーライドされます。 ButtonColumn オブジェクト内のセルをリセットして、初期状態にします。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	列の文字列形式を返します。 (DataGridColumn から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	FormatDataTextValue	指定された値を DataTextFormatString プロパティで示されている書式に変換します。
	LoadViewState	DataGridColumn オブジェクトの状態を読み込みます。 (DataGridColumn から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnColumnChanged	DataGridDesigner.OnColumnsChanged メソッドを呼び出します。 (DataGridColumn から継承されます。)
	SaveViewState	DataGridColumn オブジェクトの現在の状態を保存します。 (DataGridColumn から継承されます。)
	TrackViewState	サーバー コントロールにビューステートの変更を追跡させ、サーバー コントロールの System.Web.UI.StateBag オブジェクトに変更を格納できるようにします。 (DataGridColumn から継承されます。)

参照

関連項目

ButtonColumn クラス
System.Web.UI.WebControls 名前空間
DataGrid
DataGridColumn
BoundColumn クラス
EditCommandColumn
HyperLinkColumn
TemplateColumn
Button クラス
LinkButton