CheckBoxField Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Representa um campo booliano exibido como uma caixa de seleção em um controle com limite de dados.
public ref class CheckBoxField : System::Web::UI::WebControls::BoundFieldpublic class CheckBoxField : System.Web.UI.WebControls.BoundFieldtype CheckBoxField = class
inherit BoundFieldPublic 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.
<%@ 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 associados a dados (como GridView e DetailsView) para exibir o valor de um campo de dados booliano em uma caixa de seleção. O CheckBoxField objeto é exibido de forma diferente dependendo do controle associado a dados no qual ele é usado. Por exemplo, o GridView controle exibe um CheckBoxField objeto como uma coluna, enquanto o controle o DetailsView exibe como uma linha.
Observação
Uma caixa de seleção é desabilitada (somente leitura) até que o controle associado a dados exiba um registro que contenha a caixa de seleção no modo de edição. 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.
Para especificar o campo a ser exibido em um CheckBoxField objeto, defina a DataField propriedade com o nome do campo.
Observação
Como uma caixa de seleção pode exibir apenas um estado selecionado ou não selecionado, um CheckBoxField objeto só pode ser associado a um campo com um tipo de dados booliano ou uma cadeia de caracteres que pode ser analisada por Parse.
Você pode exibir uma legenda ao lado de cada caixa de seleção definindo a Text propriedade. Um CheckBoxField objeto fica oculto em um controle associado a dados quando a Visible propriedade é definida como false. Para impedir que o valor de um campo seja modificado no modo de edição, defina a ReadOnly propriedade como true. Em controles associados 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.
Você pode personalizar as seções de cabeçalho e rodapé de um CheckBoxField objeto. Para exibir uma legenda nas seções de cabeçalho ou rodapé, defina as propriedades ou FooterText as HeaderText propriedades, respectivamente. Em vez de exibir texto na seção de cabeçalho, você pode exibir uma imagem definindo a HeaderImageUrl propriedade. A seção de cabeçalho pode ser oculta no CheckBoxField objeto definindo a ShowHeader propriedade como false.
Observação
Alguns controles associados a dados (como o GridView controle) podem mostrar ou ocultar apenas toda a seção de cabeçalho do controle. Esses controles associados a dados não dão suporte à ShowHeader propriedade para um campo associado individual. Para mostrar ou ocultar toda a seção de cabeçalho de um controle associado a dados (se disponível), use a propriedade do ShowHeader controle.
Você também pode personalizar a aparência do objeto (cor da CheckBoxField fonte, cor da tela de fundo e assim por diante) definindo as propriedades de estilo para as diferentes partes do campo. A tabela a seguir lista as diferentes propriedades de estilo.
| Propriedade Style | Descrição |
|---|---|
| ControlStyle | As configurações de estilo para os controles filho do servidor Web do CheckBoxField objeto. |
| FooterStyle | As configurações de estilo para a seção de rodapé do CheckBoxField objeto. |
| HeaderStyle | As configurações de estilo para a seção de cabeçalho do CheckBoxField objeto. |
| ItemStyle | As configurações de estilo para os itens de dados no CheckBoxField objeto. |
Construtores
| CheckBoxField() |
Inicializa uma nova instância da classe CheckBoxField. |
Propriedades
| AccessibleHeaderText |
Obtém ou define o texto que é renderizado como o valor da propriedade |
| ApplyFormatInEditMode |
Substitui a propriedade ApplyFormatInEditMode. A classe CheckBoxField não dá suporte a esta propriedade. |
| Control |
Obtém uma referência ao controle de dados ao qual o objeto DataControlField está associado. (Herdado de DataControlField) |
| ControlStyle |
Obtém o estilo de qualquer controle do servidor Web contido pelo objeto DataControlField. (Herdado de DataControlField) |
| ConvertEmptyStringToNull |
Substitui a propriedade ConvertEmptyStringToNull. A classe CheckBoxField não dá suporte a esta propriedade. |
| DataField |
Obtém ou define o nome do campo de dados a ser associado ao objeto CheckBoxField. |
| DataFormatString |
Obtém ou define a cadeia de caracteres que especifica o formato de exibição do valor do campo. A classe CheckBoxField não dá suporte a esta propriedade. |
| DesignMode |
Obtém um valor que indica se um campo de controle de dados é atualmente exibido em um ambiente de tempo de design. (Herdado de DataControlField) |
| FooterStyle |
Obtém ou define o estilo do rodapé do campo de controle de dados. (Herdado de DataControlField) |
| FooterText |
Obtém ou define o texto exibido no item de rodapé de um campo de controle de dados. (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. (Herdado de DataControlField) |
| HeaderStyle |
Obtém ou define o estilo do cabeçalho do campo de controle de dados. (Herdado de DataControlField) |
| HeaderText |
Obtém ou define o texto exibido no cabeçalho de um controle de dados. (Herdado de BoundField) |
| HtmlEncode |
Substitui a propriedade HtmlEncode. A classe CheckBoxField não dá suporte a esta propriedade. |
| HtmlEncodeFormatString |
Obtém ou define um valor que indica se o texto formatado deve ser codificado em HTML antes de ser exibido. |
| 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. (Herdado de DataControlField) |
| IsTrackingViewState |
Obtém um valor que indica se o objeto DataControlField está salvando alterações no estado de exibição. (Herdado de DataControlField) |
| ItemStyle |
Obtém o estilo de qualquer conteúdo baseado em texto exibido por um campo de controle de dados. (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. (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. (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. (Herdado de DataControlField) |
| SupportsHtmlEncode |
Obtém um valor booliano que indica se o controle dá suporte a codificação HTML. |
| Text |
Obtém ou define a legenda a ser exibida ao lado de cada caixa de seleção em um objeto CheckBoxField. |
| ValidateRequestMode |
Obtém ou define um valor que determina se o controle valida a entrada de cliente ou não. (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. (Herdado de DataControlField) |
| Visible |
Obtém ou define um valor que indica se um campo de controle de dados é renderizado. (Herdado de DataControlField) |
Métodos
| CloneField() |
Cria uma cópia duplicada do objeto atual derivado de DataControlField. (Herdado de DataControlField) |
| CopyProperties(DataControlField) |
Copia as propriedades do objeto CheckBoxField atual para o objeto DataControlField especificado. |
| CreateField() |
Cria um objeto CheckBoxField vazio. |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| ExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean) |
Preenche o objeto IDictionary especificado com os valores do objeto DataControlFieldCell especificado. |
| FormatDataValue(Object, Boolean) |
Formata o valor do campo especificado para uma célula no objeto de BoundField. (Herdado de BoundField) |
| GetDesignTimeValue() |
Recupera o valor usado para o valor do campo ao renderizar o objeto CheckBoxField em um designer. |
| GetHashCode() |
Serve como a função de hash padrão. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| GetValue(Control) |
Recupera o valor do campo associado ao objeto de BoundField. (Herdado de BoundField) |
| Initialize(Boolean, Control) |
Inicializa o objeto BoundField. (Herdado de BoundField) |
| InitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32) |
Inicializa o objeto TableCell especificado no estado de linha especificado. (Herdado de BoundField) |
| InitializeDataCell(DataControlFieldCell, DataControlRowState) |
Inicializa o objeto DataControlFieldCell especificado no estado de linha especificado. |
| LoadViewState(Object) |
Restaura as informações de estado de exibição armazenadas anteriormente para esse campo. (Herdado de BoundField) |
| MemberwiseClone() |
Cria uma cópia superficial do Object atual. (Herdado de Object) |
| OnDataBindField(Object, EventArgs) |
Associa o valor de um campo a uma caixa de seleção no objeto CheckBoxField. |
| 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. (Herdado de DataControlField) |
| ToString() |
Retorna uma cadeia de caracteres que representa este objeto DataControlField. (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. (Herdado de DataControlField) |
| ValidateSupportsCallback() |
Determina se os controles contidos em um objeto CheckBoxField dão suporte a retornos de chamada. |
Implantações explícitas de interface
| IDataSourceViewSchemaAccessor.DataSourceViewSchema |
Obtém ou define o esquema associado a este objeto DataControlField. (Herdado de DataControlField) |
| IStateManager.IsTrackingViewState |
Obtém um valor que indica se o objeto DataControlField está salvando alterações no estado de exibição. (Herdado de DataControlField) |
| IStateManager.LoadViewState(Object) |
Restaura o estado de exibição salvo anteriormente do campo de controle de dados. (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. (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. (Herdado de DataControlField) |