Sintaxis declarativa del control de servidor Web CheckBoxList

Actualización: noviembre 2007

Crea un grupo de casillas de verificación de selección múltiple. Este control admite el enlace a un origen de datos.

<asp:CheckBoxList
    AccessKey="string"
    AppendDataBoundItems="True|False"
    AutoPostBack="True|False"
    BackColor="color name|#dddddd"
    BorderColor="color name|#dddddd"
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
        Inset|Outset"
    BorderWidth="size"
    CausesValidation="True|False"
    CellPadding="integer"
    CellSpacing="integer"
    CssClass="string"
    DataMember="string"
    DataSource="string"
    DataSourceID="string"
    DataTextField="string"
    DataTextFormatString="string"
    DataValueField="string"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    Font-Bold="True|False"
    Font-Italic="True|False"
    Font-Names="string"
    Font-Overline="True|False"
    Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
        Large|X-Large|XX-Large"
    Font-Strikeout="True|False"
    Font-Underline="True|False"
    ForeColor="color name|#dddddd"
    Height="size"
    ID="string"
    OnDataBinding="DataBinding event handler"
    OnDataBound="DataBound event handler"
    OnDisposed="Disposed event handler"
    OnInit="Init event handler"
    OnLoad="Load event handler"
    OnPreRender="PreRender event handler"
    OnSelectedIndexChanged="SelectedIndexChanged event handler"
    OnTextChanged="TextChanged event handler"
    OnUnload="Unload event handler"
    RepeatColumns="integer"
    RepeatDirection="Horizontal|Vertical"
    RepeatLayout="Table|Flow"
    runat="server"
    SelectedIndex="integer"
    SelectedValue="string"
    SkinID="string"
    Style="string"
    TabIndex="integer"
    TextAlign="Left|Right"
    ToolTip="string"
    ValidationGroup="string"
    Visible="True|False"
    Width="size"
>
            <asp:ListItem
                Enabled="True|False"
                Selected="True|False"
                Text="string"
                Value="string"
            />
</asp:CheckBoxList>

Comentarios

El control CheckBoxList crea un grupo de casillas de verificación de selección múltiple que se pueden generar dinámicamente mediante el enlace de datos. Para especificar los elementos que van a aparecer en el control CheckBoxList, coloque un elemento ListItem por cada entrada entre las etiquetas de apertura y de cierre del control CheckBoxList.

El control CheckBoxList también admite el enlace de datos. Para enlazar el control a un origen de datos, primero se crea un origen de datos, por ejemplo un objeto DataSourceControl, que contenga los elementos que se van a mostrar en el control. A continuación, se utiliza el método DataBind para enlazar el origen de datos al control CheckBoxList. Utilice las propiedades DataTextField y DataValueField para especificar el campo del origen de datos que se va a enlazar a las propiedades Text y Value, respectivamente, de cada elemento de lista del control. Ahora, el control CheckBoxList mostrará la información del origen de datos.

Para determinar los elementos seleccionados en el control CheckBoxList, recorra en iteración la colección Items y compruebe la propiedad Selected de cada elemento de la colección.

Para especificar cómo se va a mostrar la lista, utilice las propiedades RepeatLayout y RepeatDirection. Si el valor de RepeatLayout es RepeatLayout.Table (valor predeterminado), la lista se representa en una tabla. Si su valor es RepeatLayout.Flow, la lista se representa sin estructura de tabla. De manera predeterminada, RepeatDirection se establece como RepeatDirection.Vertical. Al establecer el valor de esta propiedad en RepeatDirection.Horizontal, la lista se representa horizontalmente.

Precaución:
El texto no contiene código HTML antes de mostrarse en el control CheckBoxList. Esto permite incrustar una secuencia de comandos en las etiquetas HTML del texto. Si los valores del control provienen de la entrada del usuario, asegúrese de validar los valores para ayudar a evitar puntos vulnerables en la seguridad.

Para obtener más información sobre los eventos y propiedades del control de servidor Web CheckBoxList, consulte la documentación referente a la clase CheckBoxList.

Ejemplo

En el ejemplo siguiente se muestra cómo declarar un control CheckBoxListen un archivo .aspx. La lista contiene seis elementos que no se excluyen mutuamente. Cuando un usuario activa una de las casillas, la página no se devuelve inmediatamente al servidor (la página no se envía hasta que ocurra algún otro evento, como un clic en un control Button). No se llama a ningún controlador de eventos OnSelectedIndexChanged ya que no se ha declarado ningún método para dicho evento.

  <asp:CheckBoxList id="Check1"
       RepeatLayout="flow"
       runat="server">

  <asp:ListItem>Item 1</asp:ListItem>
  <asp:ListItem>Item 2</asp:ListItem>
  <asp:ListItem>Item 3</asp:ListItem>
  <asp:ListItem>Item 4</asp:ListItem>
  <asp:ListItem>Item 5</asp:ListItem>
  <asp:ListItem>Item 6</asp:ListItem>
</asp:CheckBoxList>

  <asp:CheckBoxList id="Check1"
       RepeatLayout="flow"
       runat="server">

  <asp:ListItem>Item 1</asp:ListItem>
  <asp:ListItem>Item 2</asp:ListItem>
  <asp:ListItem>Item 3</asp:ListItem>
  <asp:ListItem>Item 4</asp:ListItem>
  <asp:ListItem>Item 5</asp:ListItem>
  <asp:ListItem>Item 6</asp:ListItem>
</asp:CheckBoxList>

En el siguiente ejemplo se muestra cómo determinar las casillas de verificación seleccionadas en un control CheckBoxList. El código recorre en iteración la colección Items del control y comprueba la propiedad Selected de cada elemento. A continuación, se muestran los elementos seleccionados en el control Label.

Sub Button1_OnClick(ByVal sender As Object, ByVal e As EventArgs)
    Dim s As String
    Dim i As Integer
    s = "Selected items:<br />"
    For i = 0 To Check1.Items.Count - 1
        If Check1.Items(i).Selected Then
            s = s & Check1.Items(i).Text & "<br />"
        End If
    Next i
    Label1.Text = s
End Sub

void Button1_OnClick(Object sender, EventArgs e)
{
    string s;
    s = "Selected items:<br />";
    for (int i = 0; i < Check1.Items.Count; i++)
    {
        if (Check1.Items[i].Selected)
        {
            s = s + Check1.Items[i].Text + "<br />";
        }
    }
    Label1.Text = s;
}

Vea también

Referencia

CheckBoxList

Otros recursos

Sintaxis de los controles de servidor Web