Deklarative Syntax des CheckBoxList-Webserversteuerelements

Aktualisiert: November 2007

Erstellt eine Gruppe von Kontrollkästchen für die Mehrfachauswahl. Dieses Steuerelement unterstützt die Bindung an eine Datenquelle.

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

Hinweise

Das CheckBoxList-Steuerelement erstellt eine Gruppe von Kontrollkästchen für die Mehrfachauswahl, die mittels Datenbindung dynamisch generiert werden kann. Um die im CheckBoxList-Steuerelement darzustellenden Elemente anzugeben, platzieren Sie für jeden Eintrag ein ListItem-Element zwischen dem Start- und dem Endtag des CheckBoxList-Steuerelements.

Tipp

Sie können auch mehrere CheckBox-Steuerelemente verwenden. Das CheckBoxList-Steuerelement eignet sich besser zum Erstellen einer Gruppe von Kontrollkästchen mit Datenbindung, während Sie bei einem einzelnen CheckBox-Steuerelement mehr Möglichkeiten für die Layoutgestaltung haben.

Das CheckBoxList-Steuerelement unterstützt auch Datenbindung. Erstellen Sie zum Binden des Steuerelements an eine Datenquelle zunächst eine Datenquelle, die die im Steuerelement anzuzeigenden Elemente enthält, z. B. eines der DataSourceControl-Objekte. Binden Sie die Datenquelle anschließend mithilfe der DataBind-Methode an das CheckBoxList-Steuerelement. Mithilfe der DataTextField-Eigenschaft und der DataValueField-Eigenschaft können Sie angeben, welches Feld der Datenquelle jeweils an die Text-Eigenschaft und die Value-Eigenschaft eines jeden Elements im Steuerelement gebunden werden soll. Das CheckBoxList-Steuerelement zeigt nun die Informationen aus der Datenquelle an.

Um die im CheckBoxList-Steuerelement ausgewählten Elemente zu bestimmen, durchlaufen Sie die Items-Auflistung, und überprüfen Sie die Selected-Eigenschaft jedes der in der Auflistung enthaltenen Elemente.

Mithilfe der RepeatLayout-Eigenschaft und der RepeatDirection-Eigenschaft können Sie angeben, auf welche Weise die Liste angezeigt werden soll. Wenn RepeatLayout auf RepeatLayout.Table festgelegt ist (Standardeinstellung), wird die Liste innerhalb einer Tabelle dargestellt. Wenn die Eigenschaft auf RepeatLayout.Flow festgelegt ist, wird die Liste ohne Tabellenstruktur dargestellt. RepeatDirection ist standardmäßig auf RepeatDirection.Vertical festgelegt. Durch Festlegen dieser Eigenschaft auf RepeatDirection.Horizontal wird die Liste horizontal dargestellt.

Warnung

Text wird erst dann in HTML codiert, wenn er im CheckBoxList-Steuerelement angezeigt wird. Auf diese Weise können Skripts in HTML-Tags in den Text eingebunden werden. Wenn die Werte in diesem Steuerelement aus Benutzereingaben stammen, müssen die Werte unbedingt validiert werden, um die Sicherheit zu gewährleisten.

Ausführliche Informationen zu den Eigenschaften und Ereignissen von CheckBoxList-Webserversteuerelementen finden Sie in der Dokumentation zur CheckBoxList-Klasse.

Beispiel

Das folgende Beispiel zeigt ein Beispiel für die Deklaration eines CheckBoxList-Steuerelementsin einer ASPX-Datei. Die Liste enthält sechs Elemente, die sich nicht gegenseitig ausschließen. Wenn ein Benutzer eines der Kontrollkästchen aktiviert, wird die Seite nicht sofort an den Server zurückgesendet. Die Seite wird erst zurückgesendet, nachdem ein bestimmtes anderes Ereignis aufgetreten ist, z. B. ein Button-Klick. Es wird kein OnSelectedIndexChanged-Ereignishandler aufgerufen, da für dieses Ereignis keine Methode deklariert wurde.

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

Das folgende Beispiel veranschaulicht, wie Sie die ausgewählten Kontrollkästchen in einem CheckBoxList-Steuerelement bestimmen können. Der Code durchläuft die Items-Auflistung des Steuerelements und überprüft die Selected-Eigenschaft eines jeden Elements. Die ausgewählten Elemente werden anschließend im Label-Steuerelement angezeigt.

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

Siehe auch

Referenz

CheckBoxList

Weitere Ressourcen

Syntax des Webserversteuerelements