CheckBoxField Classe
Definição
Representa um campo booliano exibido como uma caixa de seleção em um controle com limite de dados.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
- Herança
Exemplos
O exemplo de código a seguir demonstra como usar um CheckBoxField objeto em um GridView controle para exibir um campo de uma fonte de dados Microsoft SQL Server com um tipo de dados booliano.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>
Comentários
A CheckBoxField classe é usada por controles vinculados a dados (como GridView e DetailsView ) para exibir o valor de um campo de dados booliano em uma caixa de seleção.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. O CheckBoxField objeto é exibido de forma diferente, dependendo do controle vinculado a dados no qual ele é usado.The CheckBoxField object is displayed differently depending on the data-bound control in which it is used. Por exemplo, o GridView controle exibe um CheckBoxField objeto como uma coluna, enquanto o DetailsView controle o exibe como uma linha.For example, the GridView control displays a CheckBoxField object as a column, while the DetailsView control displays it as a row.
Observação
Uma caixa de seleção é desabilitada (somente leitura) até que o controle de vinculação de dados exiba um registro que contenha a caixa de seleção no modo de edição.A check box is disabled (read-only) until the data-bound control displays a record that contains the check box in edit mode. Para obter mais informações sobre como colocar um registro no modo de edição, consulte a documentação do controle pai que contém o CheckBoxField objeto.For more information on how to put a record into edit mode, see the documentation for the parent control that contains the CheckBoxField object.
Para especificar o campo a ser exibido em um CheckBoxField objeto, defina a DataField propriedade com o nome do campo.To specify the field to display in a CheckBoxField object, set the DataField property with the field's name.
Observação
Como uma caixa de seleção pode exibir apenas um estado selecionado ou não selecionado, um CheckBoxField objeto pode ser associado somente a um campo com um tipo de dados booliano ou uma cadeia de caracteres que pode ser analisada pelo 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.
Você pode exibir uma legenda ao lado de cada caixa de seleção definindo a Text propriedade.You can display a caption next to each check box by setting the Text property. Um CheckBoxField objeto fica oculto em um controle vinculado a dados quando a Visible propriedade é definida como false .A CheckBoxField object is hidden in a data-bound control when the Visible property is set to false. Para impedir que o valor de um campo seja modificado no modo de edição, defina a ReadOnly propriedade como true .To prevent the value of a field from being modified in edit mode, set the ReadOnly property to true. Em controles vinculados a dados que dão suporte à inserção de registros (como o DetailsView controle), você pode ocultar um CheckBoxField objeto no modo de inserção definindo a InsertVisible propriedade como 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.
Você pode personalizar as seções de cabeçalho e rodapé de um CheckBoxField objeto.You can customize the header and footer sections of a CheckBoxField object. Para exibir uma legenda nas seções de cabeçalho ou rodapé, defina as HeaderText FooterText Propriedades ou, respectivamente.To display a caption in the header or footer sections, set the HeaderText or FooterText properties, respectively. Em vez de exibir texto na seção de cabeçalho, você pode exibir uma imagem definindo a HeaderImageUrl propriedade.Instead of displaying text in the header section, you can display an image by setting the HeaderImageUrl property. A seção de cabeçalho pode ser ocultada no CheckBoxField objeto definindo a ShowHeader propriedade como false .The header section can be hidden in the CheckBoxField object by setting the ShowHeader property to false.
Observação
Alguns controles ligados a dados (como o GridView controle) podem mostrar ou ocultar apenas a seção de cabeçalho inteira do controle.Some data-bound controls (such as the GridView control) can show or hide only the entire header section of the control. Esses controles associados a dados não oferecem suporte à ShowHeader propriedade para um campo associado individual.These data-bound controls do not support the ShowHeader property for an individual bound field. Para mostrar ou ocultar a seção de cabeçalho inteira de um controle associado a dados (se disponível), use a propriedade do controle ShowHeader .To show or hide the entire header section of a data-bound control (if available), use the control's ShowHeader property.
Você também pode personalizar a aparência do CheckBoxField objeto (cor da fonte, cor do plano de fundo e assim por diante) definindo as propriedades de estilo para as diferentes partes do campo.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. A tabela a seguir lista as propriedades de estilo diferentes.The following table lists the different style properties.
| Propriedade de estiloStyle property | DescriçãoDescription |
|---|---|
| ControlStyle | As configurações de estilo para os controles de servidor Web filho do CheckBoxField objeto.The style settings for the child Web server controls of the CheckBoxField object. |
| FooterStyle | As configurações de estilo da seção de rodapé do CheckBoxField objeto.The style settings for the footer section of the CheckBoxField object. |
| HeaderStyle | As configurações de estilo da seção de cabeçalho do CheckBoxField objeto.The style settings for the header section of the CheckBoxField object. |
| ItemStyle | As configurações de estilo para os itens de dados no CheckBoxField objeto.The style settings for the data items in the CheckBoxField object. |
Construtores
| CheckBoxField() |
Inicializa uma nova instância da classe CheckBoxField.Initializes a new instance of the CheckBoxField class. |
Propriedades
| AccessibleHeaderText |
Obtém ou define o texto que é renderizado como o valor da propriedade |
| ApplyFormatInEditMode |
Substitui a propriedade ApplyFormatInEditMode.Overrides the ApplyFormatInEditMode property. A classe CheckBoxField não dá suporte a esta propriedade.This property is not supported by the CheckBoxField class. |
| Control |
Obtém uma referência ao controle de dados ao qual o objeto DataControlField está associado.Gets a reference to the data control that the DataControlField object is associated with. (Herdado de DataControlField) |
| ControlStyle |
Obtém o estilo de qualquer controle do servidor Web contido pelo objeto DataControlField.Gets the style of any Web server controls contained by the DataControlField object. (Herdado de DataControlField) |
| ConvertEmptyStringToNull |
Substitui a propriedade ConvertEmptyStringToNull.Overrides the ConvertEmptyStringToNull property. A classe CheckBoxField não dá suporte a esta propriedade.This property is not supported by the CheckBoxField class. |
| DataField |
Obtém ou define o nome do campo de dados a ser associado ao objeto CheckBoxField.Gets or sets the name of the data field to bind to the CheckBoxField object. |
| DataFormatString |
Obtém ou define a cadeia de caracteres que especifica o formato de exibição do valor do campo.Gets or sets the string that specifies the display format for the value of the field. A classe CheckBoxField não dá suporte a esta propriedade.This property is not supported by the CheckBoxField class. |
| DesignMode |
Obtém um valor que indica se um campo de controle de dados é atualmente exibido em um ambiente de tempo de design.Gets a value indicating whether a data control field is currently viewed in a design-time environment. (Herdado de DataControlField) |
| FooterStyle |
Obtém ou define o estilo do rodapé do campo de controle de dados.Gets or sets the style of the footer of the data control field. (Herdado de DataControlField) |
| FooterText |
Obtém ou define o texto exibido no item de rodapé de um campo de controle de dados.Gets or sets the text that is displayed in the footer item of a data control field. (Herdado de DataControlField) |
| HeaderImageUrl |
Obtém ou define a URL de uma imagem exibida no item de cabeçalho de um campo de controle de dados.Gets or sets the URL of an image that is displayed in the header item of a data control field. (Herdado de DataControlField) |
| HeaderStyle |
Obtém ou define o estilo do cabeçalho do campo de controle de dados.Gets or sets the style of the header of the data control field. (Herdado de DataControlField) |
| HeaderText |
Obtém ou define o texto exibido no cabeçalho de um controle de dados.Gets or sets the text that is displayed in the header of a data control. (Herdado de BoundField) |
| HtmlEncode |
Substitui a propriedade HtmlEncode.Overrides the HtmlEncode property. A classe CheckBoxField não dá suporte a esta propriedade.This property is not supported by the CheckBoxField class. |
| HtmlEncodeFormatString |
Obtém ou define um valor que indica se o texto formatado deve ser codificado em HTML antes de ser exibido.Gets or sets a value that indicates whether the formatted text should be HTML encoded before it is displayed. |
| InsertVisible |
Obtém um valor que indica se o objeto DataControlField fica visível quando o controle associado a dados pai está no modo de inserção.Gets a value indicating whether the DataControlField object is visible when its parent data-bound control is in insert mode. (Herdado de DataControlField) |
| IsTrackingViewState |
Obtém um valor que indica se o objeto DataControlField está salvando alterações no estado de exibição.Gets a value indicating whether the DataControlField object is saving changes to its view state. (Herdado de DataControlField) |
| ItemStyle |
Obtém o estilo de qualquer conteúdo baseado em texto exibido por um campo de controle de dados.Gets the style of any text-based content displayed by a data control field. (Herdado de DataControlField) |
| NullDisplayText |
Obtém ou define o texto exibido em um campo quando o valor do campo é |
| ReadOnly |
Obtém ou define um valor que indica se o valor do campo pode ser modificado no modo de edição.Gets or sets a value indicating whether the value of the field can be modified in edit mode. (Herdado de BoundField) |
| ShowHeader |
Obtém ou define um valor que indica se o item de cabeçalho de um campo de controle de dados é renderizado.Gets or sets a value indicating whether the header item of a data control field is rendered. (Herdado de DataControlField) |
| SortExpression |
Obtém ou define uma expressão de classificação que é usada por um controle de fonte de dados para classificar os dados.Gets or sets a sort expression that is used by a data source control to sort data. (Herdado de DataControlField) |
| SupportsHtmlEncode |
Obtém um valor booliano que indica se o controle dá suporte a codificação HTML.Gets a Boolean value indicating whether the control supports HTML encoding. |
| Text |
Obtém ou define a legenda a ser exibida ao lado de cada caixa de seleção em um objeto CheckBoxField.Gets or sets the caption to display next to each check box in a CheckBoxField object. |
| ValidateRequestMode |
Obtém ou define um valor que determina se o controle valida a entrada de cliente ou não.Gets or sets a value that determines whether the control validates client input or not. (Herdado de BoundField) |
| ViewState |
Obtém um dicionário de informações de estado que permite salvar e restaurar o estado de exibição de um objeto DataControlField em várias solicitações da mesma página.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. (Herdado de DataControlField) |
| Visible |
Obtém ou define um valor que indica se um campo de controle de dados é renderizado.Gets or sets a value indicating whether a data control field is rendered. (Herdado de DataControlField) |
Métodos
| CloneField() |
Cria uma cópia duplicada do objeto atual derivado de DataControlField.Creates a duplicate copy of the current DataControlField-derived object. (Herdado de DataControlField) |
| CopyProperties(DataControlField) |
Copia as propriedades do objeto CheckBoxField atual para o objeto DataControlField especificado.Copies the properties of the current CheckBoxField object to the specified DataControlField object. |
| CreateField() |
Cria um objeto CheckBoxField vazio.Creates an empty CheckBoxField object. |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object. (Herdado de Object) |
| ExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean) |
Preenche o objeto IDictionary especificado com os valores do objeto DataControlFieldCell especificado.Fills the specified IDictionary object with the values from the specified DataControlFieldCell object. |
| FormatDataValue(Object, Boolean) |
Formata o valor do campo especificado para uma célula no objeto de BoundField.Formats the specified field value for a cell in the BoundField object. (Herdado de BoundField) |
| GetDesignTimeValue() |
Recupera o valor usado para o valor do campo ao renderizar o objeto CheckBoxField em um designer.Retrieves the value used for the field's value when rendering the CheckBoxField object in a designer. |
| GetHashCode() |
Serve como a função de hash padrão.Serves as the default hash function. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual.Gets the Type of the current instance. (Herdado de Object) |
| GetValue(Control) |
Recupera o valor do campo associado ao objeto de BoundField.Retrieves the value of the field bound to the BoundField object. (Herdado de BoundField) |
| Initialize(Boolean, Control) |
Inicializa o objeto BoundField.Initializes the BoundField object. (Herdado de BoundField) |
| InitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32) |
Inicializa o objeto TableCell especificado no estado de linha especificado.Initializes the specified TableCell object to the specified row state. (Herdado de BoundField) |
| InitializeDataCell(DataControlFieldCell, DataControlRowState) |
Inicializa o objeto DataControlFieldCell especificado no estado de linha especificado.Initializes the specified DataControlFieldCell object to the specified row state. |
| LoadViewState(Object) |
Restaura as informações de estado de exibição armazenadas anteriormente para esse campo.Restores the previously stored view-state information for this field. (Herdado de BoundField) |
| MemberwiseClone() |
Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object. (Herdado de Object) |
| OnDataBindField(Object, EventArgs) |
Associa o valor de um campo a uma caixa de seleção no objeto CheckBoxField.Binds the value of a field to a check box in the CheckBoxField object. |
| OnFieldChanged() |
Aciona o evento |
| SaveViewState() |
Salva as alterações feitas no estado de exibição DataControlField desde a hora em que a página foi postada de volta no servidor.Saves the changes made to the DataControlField view state since the time the page was posted back to the server. (Herdado de DataControlField) |
| ToString() |
Retorna uma cadeia de caracteres que representa este objeto DataControlField.Returns a string that represents this DataControlField object. (Herdado de DataControlField) |
| TrackViewState() |
Faz com que o objeto DataControlField controle as alterações em seu estado de exibição, de modo que elas possam ser armazenadas na propriedade ViewState do controle e persistidas entre solicitações para a mesma página.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. (Herdado de DataControlField) |
| ValidateSupportsCallback() |
Determina se os controles contidos em um objeto CheckBoxField dão suporte a retornos de chamada.Determines whether the controls contained in a CheckBoxField object support callbacks. |
Implantações explícitas de interface
| IDataSourceViewSchemaAccessor.DataSourceViewSchema |
Obtém ou define o esquema associado a este objeto DataControlField.Gets or sets the schema associated with this DataControlField object. (Herdado de DataControlField) |
| IStateManager.IsTrackingViewState |
Obtém um valor que indica se o objeto DataControlField está salvando alterações no estado de exibição.Gets a value indicating whether the DataControlField object is saving changes to its view state. (Herdado de DataControlField) |
| IStateManager.LoadViewState(Object) |
Restaura o estado de exibição salvo anteriormente do campo de controle de dados.Restores the data control field's previously saved view state. (Herdado de DataControlField) |
| IStateManager.SaveViewState() |
Salva as alterações feitas no estado de exibição DataControlField desde a hora em que a página foi postada de volta no servidor.Saves the changes made to the DataControlField view state since the time the page was posted back to the server. (Herdado de DataControlField) |
| IStateManager.TrackViewState() |
Faz com que o objeto DataControlField controle as alterações em seu estado de exibição, de modo que elas possam ser armazenadas na propriedade ViewState do controle e persistidas entre solicitações para a mesma página.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. (Herdado de DataControlField) |