CheckBoxField クラス

定義

データ バインド コントロール内にチェック ボックスとして表示される Boolean フィールドを表します。Represents a Boolean field that is displayed as a check box in a data-bound control.

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

次のコード例では、コントロールのオブジェクトを使用し CheckBoxField GridView て、ブールデータ型の Microsoft SQL Server データソースのフィールドを表示する方法を示します。The following code example demonstrates how to use a CheckBoxField object in a GridView control to display a field from a Microsoft SQL Server data source with a Boolean data type.


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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>CheckBoxField Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>CheckBoxField Example</h3>

      <asp:gridview id="AuthorsGridView" 
        datasourceid="AuthorsSqlDataSource" 
        autogeneratecolumns="False"
        runat="server">
                
        <columns>
                
          <asp:boundfield datafield="au_lname"
            headertext="Last Name"/>
                    
          <asp:checkboxfield datafield="contract"
            text="Contract"
            headertext="Contract"/>     
                
        </columns>
                
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects -->
      <!-- to the Pubs sample database.                        -->
      <asp:sqldatasource id="AuthorsSqlDataSource"  
        selectcommand="SELECT [au_lname], [au_fname], [address], [city], [state], [zip], [contract] FROM [authors]"
        connectionstring="server=localhost;database=pubs;integrated security=SSPI"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>


<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>CheckBoxField Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>CheckBoxField Example</h3>

      <asp:gridview id="AuthorsGridView" 
        datasourceid="AuthorsSqlDataSource" 
        autogeneratecolumns="False"
        runat="server">
                
        <columns>
                
          <asp:boundfield datafield="au_lname"
            headertext="Last Name"/>
                    
          <asp:checkboxfield datafield="contract"
            text="Contract"
            headertext="Contract"/>     
                
        </columns>
                
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects -->
      <!-- to the Pubs sample database.                        -->
      <asp:sqldatasource id="AuthorsSqlDataSource"  
        selectcommand="SELECT [au_lname], [au_fname], [address], [city], [state], [zip], [contract] FROM [authors]"
        connectionstring="server=localhost;database=pubs;integrated security=SSPI"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

注釈

クラスは、 CheckBoxField データバインドコントロール (やなど) によって、 GridView DetailsView ブールデータフィールドの値をチェックボックスに表示するために使用されます。The CheckBoxField class is used by data-bound controls (such as GridView and DetailsView) to display the value of a Boolean data field in a check box. オブジェクトは、使用される CheckBoxField データバインドコントロールによって異なる方法で表示されます。The CheckBoxField object is displayed differently depending on the data-bound control in which it is used. たとえば、コントロールによって GridView オブジェクトが列として表示され、 CheckBoxField コントロールにはそのオブジェクトが行として表示され DetailsView ます。For example, the GridView control displays a CheckBoxField object as a column, while the DetailsView control displays it as a row.

注意

チェックボックスは、データバインドコントロールが編集モードのチェックボックスを含むレコードを表示するまで、無効 (読み取り専用) になります。A check box is disabled (read-only) until the data-bound control displays a record that contains the check box in edit mode. レコードを編集モードにする方法の詳細については、オブジェクトが含まれている親コントロールのドキュメントを参照してください CheckBoxFieldFor more information on how to put a record into edit mode, see the documentation for the parent control that contains the CheckBoxField object.

オブジェクトに表示するフィールドを指定するには、 CheckBoxField フィールドの名前を使用してプロパティを設定し DataField ます。To specify the field to display in a CheckBoxField object, set the DataField property with the field's name.

注意

チェックボックスでは、選択した状態または選択されていない状態のみを表示できるため、オブジェクトをバインドできるのは、 CheckBoxField ブールデータ型のフィールド、またはで解析できる文字列のみ Parse です。Because a check box can display only a selected or an unselected state, a CheckBoxField object can be bound only to a field with a Boolean data type or a string that can be parsed by Parse.

各チェックボックスの横に、プロパティを設定してキャプションを表示でき Text ます。You can display a caption next to each check box by setting the Text property. CheckBoxField Visible プロパティがに設定されている場合、データバインドコントロールでオブジェクトが非表示になり false ます。A CheckBoxField object is hidden in a data-bound control when the Visible property is set to false. フィールドの値が編集モードで変更されないようにするには、プロパティをに設定し ReadOnly true ます。To prevent the value of a field from being modified in edit mode, set the ReadOnly property to true. レコードの挿入をサポートするデータバインドコントロール (コントロールなど) では、 DetailsView CheckBoxField プロパティをに設定することによって、挿入モードでオブジェクトを非表示にすることができ InsertVisible false ます。In data-bound controls that support inserting records (such as the DetailsView control), you can hide a CheckBoxField object in insert mode by setting the InsertVisible property to false.

オブジェクトのヘッダーセクションとフッターセクションをカスタマイズでき CheckBoxField ます。You can customize the header and footer sections of a CheckBoxField object. ヘッダーセクションまたはフッターセクションにキャプションを表示するに HeaderText は、 FooterText プロパティまたはプロパティをそれぞれ設定します。To display a caption in the header or footer sections, set the HeaderText or FooterText properties, respectively. ヘッダーセクションにテキストを表示する代わりに、プロパティを設定してイメージを表示でき HeaderImageUrl ます。Instead of displaying text in the header section, you can display an image by setting the HeaderImageUrl property. ヘッダーセクションは、 CheckBoxField プロパティをに設定することによって、オブジェクトで非表示にすることができ ShowHeader false ます。The header section can be hidden in the CheckBoxField object by setting the ShowHeader property to false.

注意

一部のデータバインドコントロール ( GridView コントロールなど) では、コントロールのヘッダーセクション全体だけを表示または非表示にすることができます。Some data-bound controls (such as the GridView control) can show or hide only the entire header section of the control. これらのデータバインドコントロールは、 ShowHeader 個々のバインドされたフィールドのプロパティをサポートしていません。These data-bound controls do not support the ShowHeader property for an individual bound field. データバインドコントロールのヘッダーセクション全体 (使用可能な場合) を表示または非表示にするには、コントロールのプロパティを使用し ShowHeader ます。To show or hide the entire header section of a data-bound control (if available), use the control's ShowHeader property.

また、 CheckBoxField フィールドのさまざまな部分のスタイルプロパティを設定して、オブジェクト (フォントの色、背景色など) の外観をカスタマイズすることもできます。You also can customize the appearance of the CheckBoxField object (font color, background color, and so on) by setting the style properties for the different parts of the field. 次の表は、さまざまなスタイルプロパティを示しています。The following table lists the different style properties.

Style プロパティStyle property 説明Description
ControlStyle オブジェクトの子 Web サーバーコントロールのスタイル設定 CheckBoxFieldThe style settings for the child Web server controls of the CheckBoxField object.
FooterStyle オブジェクトのフッターセクションのスタイル設定 CheckBoxFieldThe style settings for the footer section of the CheckBoxField object.
HeaderStyle オブジェクトのヘッダーセクションのスタイル設定 CheckBoxFieldThe style settings for the header section of the CheckBoxField object.
ItemStyle オブジェクト内のデータ項目のスタイル設定 CheckBoxFieldThe style settings for the data items in the CheckBoxField object.

コンストラクター

CheckBoxField()

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

プロパティ

AccessibleHeaderText

一部のコントロールの AbbreviatedText プロパティ値として表示されるテキストを取得または設定します。Gets or sets text that is rendered as the AbbreviatedText property value in some controls.

(継承元 DataControlField)
ApplyFormatInEditMode

ApplyFormatInEditMode プロパティをオーバーライドします。Overrides the ApplyFormatInEditMode property. このプロパティは CheckBoxField クラスではサポートされていません。This property is not supported by the CheckBoxField class.

Control

DataControlField オブジェクトが関連付けられているデータ コントロールの参照を取得します。Gets a reference to the data control that the DataControlField object is associated with.

(継承元 DataControlField)
ControlStyle

DataControlField オブジェクトに格納されているすべての Web サーバー コントロールのスタイルを取得します。Gets the style of any Web server controls contained by the DataControlField object.

(継承元 DataControlField)
ConvertEmptyStringToNull

ConvertEmptyStringToNull プロパティをオーバーライドします。Overrides the ConvertEmptyStringToNull property. このプロパティは CheckBoxField クラスではサポートされていません。This property is not supported by the CheckBoxField class.

DataField

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

DataFormatString

フィールドの値の表示形式を指定する文字列を取得または設定します。Gets or sets the string that specifies the display format for the value of the field. このプロパティは CheckBoxField クラスではサポートされていません。This property is not supported by the CheckBoxField class.

DesignMode

デザイン時環境で、現在データ コントロール フィールドが表示されているかどうかを示す値を取得します。Gets a value indicating whether a data control field is currently viewed in a design-time environment.

(継承元 DataControlField)
FooterStyle

データ コントロール フィールドのフッターのスタイルを取得または設定します。Gets or sets the style of the footer of the data control field.

(継承元 DataControlField)
FooterText

データ コントロール フィールドのフッター項目に表示されるテキストを取得または設定します。Gets or sets the text that is displayed in the footer item of a data control field.

(継承元 DataControlField)
HeaderImageUrl

データ コントロール フィールドのヘッダー項目に表示されるイメージの URL を取得または設定します。Gets or sets the URL of an image that is displayed in the header item of a data control field.

(継承元 DataControlField)
HeaderStyle

データ コントロール フィールドのヘッダーのスタイルを取得または設定します。Gets or sets the style of the header of the data control field.

(継承元 DataControlField)
HeaderText

データ コントロールのヘッダーに表示するテキストを取得または設定します。Gets or sets the text that is displayed in the header of a data control.

(継承元 BoundField)
HtmlEncode

HtmlEncode プロパティをオーバーライドします。Overrides the HtmlEncode property. このプロパティは CheckBoxField クラスではサポートされていません。This property is not supported by the CheckBoxField class.

HtmlEncodeFormatString

書式設定されたテキストを表示する前に、そのテキストを HTML エンコードするかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the formatted text should be HTML encoded before it is displayed.

InsertVisible

DataControlField オブジェクトの親データ バインド コントロールが挿入モードの場合に、このオブジェクトが表示されるかどうかを示す値を取得します。Gets a value indicating whether the DataControlField object is visible when its parent data-bound control is in insert mode.

(継承元 DataControlField)
IsTrackingViewState

DataControlField オブジェクトがビューステートへの変更を保存しているかどうかを示す値を取得します。Gets a value indicating whether the DataControlField object is saving changes to its view state.

(継承元 DataControlField)
ItemStyle

データ コントロール フィールドで表示されるテキスト ベースの内容のスタイルを取得します。Gets the style of any text-based content displayed by a data control field.

(継承元 DataControlField)
NullDisplayText

フィールドの値が null の場合に、そのフィールドに表示するテキストを取得または設定します。Gets or sets the text displayed for a field when the field's value is null. このプロパティは CheckBoxField クラスではサポートされていません。This property is not supported by the CheckBoxField class.

ReadOnly

編集モードでフィールドの値を変更できるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the value of the field can be modified in edit mode.

(継承元 BoundField)
ShowHeader

データ コントロール フィールドのヘッダー項目を表示するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the header item of a data control field is rendered.

(継承元 DataControlField)
SortExpression

データ ソース コントロールでデータを並べ替えるために使用される並べ替え式を、取得または設定します。Gets or sets a sort expression that is used by a data source control to sort data.

(継承元 DataControlField)
SupportsHtmlEncode

コントロールが HTML エンコーディングをサポートしているかどうか示すブール値を取得します。Gets a Boolean value indicating whether the control supports HTML encoding.

Text

CheckBoxField オブジェクトの各チェック ボックスの横に表示されるキャプションを取得または設定します。Gets or sets the caption to display next to each check box in a CheckBoxField object.

ValidateRequestMode

コントロールがクライアントの入力を検証するかどうかを決定する値を取得または設定します。Gets or sets a value that determines whether the control validates client input or not.

(継承元 BoundField)
ViewState

同一のページに対する複数の要求にわたって、DataControlField オブジェクトのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。Gets a dictionary of state information that allows you to save and restore the view state of a DataControlField object across multiple requests for the same page.

(継承元 DataControlField)
Visible

データ コントロール フィールドを表示するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether a data control field is rendered.

(継承元 DataControlField)

メソッド

CloneField()

現在の DataControlField 派生オブジェクトのコピーを作成します。Creates a duplicate copy of the current DataControlField-derived object.

(継承元 DataControlField)
CopyProperties(DataControlField)

CheckBoxField オブジェクトの現在のプロパティを、指定された DataControlField オブジェクトにコピーします。Copies the properties of the current CheckBoxField object to the specified DataControlField object.

CreateField()

空の CheckBoxField オブジェクトを作成します。Creates an empty CheckBoxField object.

Equals(Object)

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

(継承元 Object)
ExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean)

指定した IDictionary オブジェクトに、指定した DataControlFieldCell オブジェクトの値を読み込みます。Fills the specified IDictionary object with the values from the specified DataControlFieldCell object.

FormatDataValue(Object, Boolean)

BoundField オブジェクトのセルの指定したフィールド値を書式変換します。Formats the specified field value for a cell in the BoundField object.

(継承元 BoundField)
GetDesignTimeValue()

CheckBoxField オブジェクトがデザイナーに表示されるときに、フィールドの値として使用される値を取得します。Retrieves the value used for the field's value when rendering the CheckBoxField object in a designer.

GetHashCode()

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

(継承元 Object)
GetType()

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

(継承元 Object)
GetValue(Control)

BoundField オブジェクトにバインドされているフィールドの値を取得します。Retrieves the value of the field bound to the BoundField object.

(継承元 BoundField)
Initialize(Boolean, Control)

BoundField オブジェクトを初期化します。Initializes the BoundField object.

(継承元 BoundField)
InitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32)

指定された TableCell オブジェクトを、指定された行の状態に初期化します。Initializes the specified TableCell object to the specified row state.

(継承元 BoundField)
InitializeDataCell(DataControlFieldCell, DataControlRowState)

指定された DataControlFieldCell オブジェクトを、指定された行の状態に初期化します。Initializes the specified DataControlFieldCell object to the specified row state.

LoadViewState(Object)

このフィールドの、以前保存したビューステート情報を復元します。Restores the previously stored view-state information for this field.

(継承元 BoundField)
MemberwiseClone()

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

(継承元 Object)
OnDataBindField(Object, EventArgs)

フィールドの値を CheckBoxField オブジェクトのチェック ボックスにバインドします。Binds the value of a field to a check box in the CheckBoxField object.

OnFieldChanged()

FieldChanged イベントを発生させます。Raises the FieldChanged event.

(継承元 DataControlField)
SaveViewState()

ページがサーバーにポストバックされた時間以降に発生した、DataControlField ビューステートへの変更を保存します。Saves the changes made to the DataControlField view state since the time the page was posted back to the server.

(継承元 DataControlField)
ToString()

この DataControlField オブジェクトを表す文字列を返します。Returns a string that represents this DataControlField object.

(継承元 DataControlField)
TrackViewState()

DataControlField オブジェクトがそのビューステートの変更を追跡するようにします。それにより、変更をコントロールの ViewState プロパティに格納して、同じページに対する複数の要求にわたって永続化できます。Causes the DataControlField object to track changes to its view state so they can be stored in the control's ViewState property and persisted across requests for the same page.

(継承元 DataControlField)
ValidateSupportsCallback()

CheckBoxField オブジェクトに格納されているコントロールがコールバックをサポートしているかどうかを確認します。Determines whether the controls contained in a CheckBoxField object support callbacks.

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

IDataSourceViewSchemaAccessor.DataSourceViewSchema

DataControlField オブジェクトに関連付けられているスキーマを取得または設定します。Gets or sets the schema associated with this DataControlField object.

(継承元 DataControlField)
IStateManager.IsTrackingViewState

DataControlField オブジェクトがビューステートへの変更を保存しているかどうかを示す値を取得します。Gets a value indicating whether the DataControlField object is saving changes to its view state.

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

データ コントロール フィールドの、以前保存したビューステートを復元します。Restores the data control field's previously saved view state.

(継承元 DataControlField)
IStateManager.SaveViewState()

ページがサーバーにポストバックされた時間以降に発生した、DataControlField ビューステートへの変更を保存します。Saves the changes made to the DataControlField view state since the time the page was posted back to the server.

(継承元 DataControlField)
IStateManager.TrackViewState()

DataControlField オブジェクトがそのビューステートの変更を追跡するようにします。それにより、変更をコントロールの ViewState プロパティに格納して、同じページに対する複数の要求にわたって永続化できます。Causes the DataControlField object to track changes to its view state so they can be stored in the control's ViewState property and persisted across requests for the same page.

(継承元 DataControlField)

適用対象

こちらもご覧ください