Syntaxe déclarative du contrôle serveur Web CheckBoxList

Mise à jour : novembre 2007

Crée un groupe de cases à cocher à sélection multiple. Ce contrôle prend en charge la liaison à une source de données.

<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>

Notes

Le contrôle CheckBoxList crée un groupe de cases à cocher à sélection multiple qui peut être dynamiquement généré à l'aide de la liaison de données. Pour spécifier les éléments que vous voulez voir apparaître dans le contrôle CheckBoxList, insérez un élément ListItem pour chaque entrée entre les balises d'ouverture et de fermeture du contrôle CheckBoxList.

Remarque :
Vous pouvez également utiliser plusieurs contrôles CheckBox. Le contrôle CheckBoxList permet de créer plus facilement un groupe de cases à cocher à l'aide de la liaison de données, tandis que le contrôle CheckBox individuel offre un meilleur contrôle de la mise en page.

Le contrôle CheckBoxList prend également en charge la liaison de données. Pour lier le contrôle à une source de données, commencez par créer une source de données, par exemple l'un des objets DataSourceControl, qui contient les éléments à afficher dans le contrôle. Ensuite, utilisez la méthode DataBind pour lier la source de données au contrôle CheckBoxList. Utilisez les propriétés DataTextField et DataValueField pour spécifier les champs de la source de données à lier respectivement aux propriétés Text et Value de chaque élément de liste du contrôle. Le contrôle CheckBoxList affichera désormais les informations à partir de la source de données.

Pour déterminer les éléments sélectionnés dans le contrôle CheckBoxList, effectuez une itération dans la collection Items et testez la propriété Selected de chaque élément de la collection.

Vous pouvez spécifier la manière dont la liste est affichée en utilisant les propriétés RepeatLayout et RepeatDirection. Si la propriété RepeatLayout a la valeur RepeatLayout.Table (paramètre par défaut), la liste est rendue dans un tableau. Si elle a la valeur RepeatLayout.Flow, la liste est rendue sans structure de tableau. Par défaut, RepeatDirection a la valeur RepeatDirection.Vertical. L'affectation de la valeur RepeatDirection.Horizontal à cette propriété rend la liste horizontalement.

Attention :
Le texte n'est pas codé au format HTML avant d'être affiché dans le contrôle CheckBoxList. Il est ainsi possible d'incorporer du script dans les balises HTML dans le texte. Si les valeurs du contrôle proviennent des entrées d'utilisateur, veillez à valider les valeurs pour permettre d'empêcher les failles en matière de sécurité.

Pour plus d'informations sur les propriétés et événements du contrôle serveur Web CheckBoxList, consultez la documentation de la classe CheckBoxList.

Exemple

Le code suivant illustre un exemple de déclaration d'un contrôle CheckBoxList dans un fichier .aspx. La liste contient six éléments qui ne s'excluent pas mutuellement. Quand l'utilisateur active l'une des cases, la page n'est pas immédiatement publiée sur le serveur (elle n'est pas publiée tant qu'un autre événement ne se produit pas, comme un clic sur Button). Aucun gestionnaire d'événements OnSelectedIndexChanged n'est appelé car aucune méthode n'est déclarée pour cet événement.

  <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>

L'exemple suivant montre comment déterminer les cases à cocher sélectionnées dans un contrôle CheckBoxList. Le code parcourt la collection Items du contrôle et teste la propriété Selected de chaque élément. Les éléments sélectionnés sont ensuite affichés dans le contrôle 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;
}

Voir aussi

Référence

CheckBoxList

Autres ressources

Syntaxe des contrôles serveur Web