ButtonColumn クラス

定義

ユーザー定義のボタンを格納する DataGrid コントロールの列の種類。A column type for the DataGrid control that contains a user-defined button.

public ref class ButtonColumn : System::Web::UI::WebControls::DataGridColumn
public class ButtonColumn : System.Web.UI.WebControls.DataGridColumn
type ButtonColumn = class
    inherit DataGridColumn
Public Class ButtonColumn
Inherits DataGridColumn
継承
ButtonColumn

次のコード例は、コントロールでクラスを使用して、追加ボタンを作成する方法を示して ButtonColumn DataGrid います。 AddThe following code example demonstrates how to use ButtonColumn class in a DataGrid control to create Add buttons.

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);
}

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

注釈

コントロールのクラスを使用して、コントロールの各行 ButtonColumn DataGrid に対応するボタンを作成し DataGrid ます。Use the ButtonColumn class in a DataGrid control to create a button that corresponds with each row in the DataGrid control. プロパティを設定して、ボタンに表示されるキャプションを指定し Text ます。Specify the caption that is displayed in the buttons by setting the Text property. プロパティを設定した場合 Text 、オブジェクト内のすべてのボタンが ButtonColumn 同じキャプションを共有します。If you set the Text property, all buttons in the ButtonColumn object share the same caption. または、 ButtonColumn データソースのフィールドにボタンをバインドすることもできます。Alternatively, you can bind the ButtonColumn buttons to a field in a data source. これにより、ボタンごとに異なるキャプションを表示できます。This allows you to display different captions for each button. 指定したフィールドの値は、テキストキャプションに使用されます。The values in the specified field are used for the text caption. DataTextField ButtonColumn データソースのフィールドにバインドするには、プロパティを設定します。Set the DataTextField property to bind the ButtonColumn to a field in a data source.

ボタンに表示されるキャプションは、書式設定文字列を使用してプロパティを設定することによって書式設定でき DataTextField ます。You can format the captions that are displayed in the buttons by setting the DataTextField property with a formatting string.

のボタンをクリックすると、 ButtonColumn イベントが発生し ItemCommand ます。Clicking the buttons in the ButtonColumn raises the ItemCommand event. イベントのイベントハンドラーを指定することで、ボタンがクリックされたときに実行されるアクションをプログラムで制御でき ItemCommand ます。You can programmatically control the action that is performed when the button is clicked by providing an event handler for the ItemCommand event.

既定では、のボタンをクリックしても、ページの検証は実行されません ButtonColumnBy default, page validation is not performed when a button in the ButtonColumn is clicked. ページの検証では、ページ上の検証コントロールに関連付けられている入力コントロールが、検証コントロールによって指定された検証規則に合格するかどうかを判断します。Page validation determines whether the input controls that are associated with a validation control on the page all pass the validation rules that are specified by the validation control. ボタンがクリックされたときにページの検証を実行するには、プロパティをに設定し CausesValidation true ます。To perform page validation when a button is clicked, set the CausesValidation property to true.

コンストラクター

ButtonColumn()

ButtonColumn クラスの新しいインスタンスを初期化します。Initializes a new instance of the ButtonColumn class.

プロパティ

ButtonType

ButtonColumn オブジェクトに表示するボタンの種類を取得または設定します。Gets or sets the type of button to display in the ButtonColumn object.

CausesValidation

ButtonColumn オブジェクトのボタンがクリックされたときに検証を実行するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether validation is performed when a button in the ButtonColumn object is clicked.

CommandName

ButtonColumn オブジェクトのボタンがクリックされたときに実行するコマンドを表す文字列を取得または設定します。Gets or sets a string that represents the command to perform when a button in the ButtonColumn object is clicked.

DataTextField

ButtonColumn オブジェクトにバインドするデータ ソースのフィールド名を取得または設定します。Gets or sets the field name from a data source to bind to the ButtonColumn object.

DataTextFormatString

各ボタンのキャプションの表示形式を指定する文字列を取得または設定します。Gets or sets the string that specifies the display format for the caption in each button.

DesignMode

列がデザイン モードかどうかを示す値を取得します。Gets a value that indicates whether the column is in design mode.

(継承元 DataGridColumn)
FooterStyle

列のフッター セクションのスタイル プロパティを取得します。Gets the style properties for the footer section of the column.

(継承元 DataGridColumn)
FooterText

列のフッター セクションに表示されるテキストを取得または設定します。Gets or sets the text displayed in the footer section of the column.

(継承元 DataGridColumn)
HeaderImageUrl

列のヘッダー セクションに表示するイメージの位置を取得または設定します。Gets or sets the location of an image to display in the header section of the column.

(継承元 DataGridColumn)
HeaderStyle

列のヘッダー セクションのスタイル プロパティを取得します。Gets the style properties for the header section of the column.

(継承元 DataGridColumn)
HeaderText

列のヘッダー セクションに表示されるテキストを取得または設定します。Gets or sets the text displayed in the header section of the column.

(継承元 DataGridColumn)
IsTrackingViewState

DataGridColumn オブジェクトが状態を保存するようにマークされているかどうかを判断する値を取得します。Gets a value that determines whether the DataGridColumn object is marked to save its state.

(継承元 DataGridColumn)
ItemStyle

列の項目セルのスタイル プロパティを取得します。Gets the style properties for the item cells of the column.

(継承元 DataGridColumn)
Owner

列がメンバーとして含まれている DataGrid コントロールを取得します。Gets the DataGrid control that the column is a member of.

(継承元 DataGridColumn)
SortExpression

並べ替えのために列が選択された場合に、OnSortCommand(DataGridSortCommandEventArgs) メソッドに渡されるフィールドの名前または式を、取得または設定します。Gets or sets the name of the field or expression to pass to the OnSortCommand(DataGridSortCommandEventArgs) method when a column is selected for sorting.

(継承元 DataGridColumn)
Text

ButtonColumn オブジェクトのボタンに表示するキャプションを取得または設定します。Gets or sets the caption that is displayed in the buttons of the ButtonColumn object.

ValidationGroup

ButtonColumn オブジェクトがサーバーにポストバックされるときに、このオブジェクトによって発生する検証の対象となる検証コントロールのグループを取得または設定します。Gets or sets the group of validation controls for which the ButtonColumn object causes validation when it posts back to the server.

ViewState

StateBag クラスから派生した列がそのプロパティを格納できるようにする DataGridColumn オブジェクトを取得します。Gets the StateBag object that allows a column derived from the DataGridColumn class to store its properties.

(継承元 DataGridColumn)
Visible

DataGrid コントロールに列を表示するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the column is visible in the DataGrid control.

(継承元 DataGridColumn)

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
FormatDataTextValue(Object)

指定された値を DataTextFormatString プロパティで示されている書式に変換します。Converts the specified value to the format that is indicated by the DataTextFormatString property.

GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
Initialize()

ButtonColumn オブジェクトを初期状態にリセットします。Resets the ButtonColumn object to its initial state.

InitializeCell(TableCell, Int32, ListItemType)

ButtonColumn オブジェクト内のセルをリセットして、初期状態にします。Resets a cell in the ButtonColumn object to its initial state.

LoadViewState(Object)

DataGridColumn オブジェクトの状態を読み込みます。Loads the state of the DataGridColumn object.

(継承元 DataGridColumn)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
OnColumnChanged()

OnColumnsChanged() メソッドを呼び出します。Calls the OnColumnsChanged() method.

(継承元 DataGridColumn)
SaveViewState()

DataGridColumn オブジェクトの現在の状態を保存します。Saves the current state of the DataGridColumn object.

(継承元 DataGridColumn)
ToString()

列の文字列形式を返します。Returns the string representation of the column.

(継承元 DataGridColumn)
TrackViewState()

サーバー コントロールにビューステートの変更を追跡させ、サーバー コントロールの StateBag オブジェクトに変更を格納できるようにします。Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object.

(継承元 DataGridColumn)

明示的なインターフェイスの実装

IStateManager.IsTrackingViewState

列がビューステートの変化を追跡しているかどうかを示す値を取得します。Gets a value that indicates whether the column is tracking view state changes.

(継承元 DataGridColumn)
IStateManager.LoadViewState(Object)

以前に保存した状態を読み込みます。Loads previously saved state.

(継承元 DataGridColumn)
IStateManager.SaveViewState()

状態の変化を示すオブジェクトを返します。Returns an object containing state changes.

(継承元 DataGridColumn)
IStateManager.TrackViewState()

状態変化の追跡を開始します。Starts tracking state changes.

(継承元 DataGridColumn)

適用対象

こちらもご覧ください