Vue d'ensemble du contrôle serveur Web ListBox

Article
10/22/2014

Mise à jour : novembre 2007

Le contrôle serveur Web ListBox permet aux utilisateurs de sélectionner un ou plusieurs éléments dans une liste prédéfinie.

Cette rubrique contient les sections suivantes :

Scénarios
Fonctionnalités
Contexte
Exemples de code
Référence de classe

Scénarios

Utilisez le contrôle serveur Web ListBox lorsque vous souhaitez afficher des structures complexe et permettre aux utilisateurs de sélectionner un ou plusieurs éléments dans une liste prédéfinie. Le contrôle ListBox diffère du contrôle DropDownList dans la mesure où il peut afficher plusieurs éléments à la fois et peut permettre à l'utilisateur d'en sélectionner plusieurs.

Retour au début

Fonctionnalités

Vous pouvez utiliser le contrôle ListBox pour :

Définir le contrôle pour afficher un nombre spécifique d'éléments.
Définir la taille du contrôle en pixels.
Utiliser la liaison de données pour spécifier la liste des éléments à afficher.
Déterminer quel élément ou éléments sont sélectionnés.
Spécifier par programme l'élément ou les éléments sélectionnés.

Retour au début

Contexte

Le contrôle ListBox est généralement utilisé pour afficher plusieurs éléments à la fois. Vous pouvez contrôler l'apparence de la liste des manières suivantes :

Nombre de lignes affichées. Vous pouvez définir le contrôle de telle façon qu'il affiche un nombre spécifique d'éléments. Si le contrôle contient plus d'éléments que prévu il affiche une barre de défilement verticale.
Hauteur et largeur. Vous pouvez définir la taille du contrôle en pixels. Dans ce cas, le contrôle ignore le nombre de lignes que vous avez défini et en affiche autant que sa hauteur lui permet de contenir. Certains navigateurs ne prennent pas en charge la définition de la hauteur et de la largeur en pixels et utilisent le nombre de lignes comme paramètre.

Tout comme avec d'autres contrôles serveur Web, vous pouvez utiliser des objets style pour spécifier l'apparence du contrôle. Pour plus d'informations, consultez Contrôles serveur Web ASP.NET et styles CSS.

Éléments de liste

Le contrôle ListBox est un conteneur destiné à recevoir un ou plusieurs éléments de liste. Chaque élément de liste est un objet de type ListItem avec ses propres propriétés. Ces propriétés sont décrites dans le tableau ci-après.

Propriété	Description
Text	Spécifie le texte affiché dans la liste.
Value	Contient la valeur associée à un élément. Si vous définissez cette propriété, vous pouvez associer une valeur à un élément spécifique sans l'afficher. Par exemple, la propriété Text peut avoir pour valeur le nom d'une couleur et la propriété Value sa représentation hexadécimale.
Selected	Indique si l'élément est actuellement sélectionné.

Pour manipuler des éléments par programme, vous utilisez la collection Items du contrôle ListBox. Items est une collection standard ; vous pouvez y ajouter des éléments, en supprimer, effacer la collection, etc.

L'élément actuellement sélectionné est disponible dans la propriété SelectedItem du contrôle ListBox. Si le contrôle est en mode de sélection simple, cette propriété retourne le premier élément sélectionné. Si le contrôle est en mode de sélection multiple, vos obtenez les éléments sélectionnés en parcourant l'entière collection Items et en examinant la propriété Selected de chaque élément.

Sélection multiple contre sélection unique

Les utilisateurs peuvent normalement sélectionner un élément unique de la liste en cliquant dessus. Si vous définissez le contrôle ListBox de manière à autoriser des sélections multiples, les utilisateurs peuvent maintenir la touche CTRL ou MAJ enfoncée tout en cliquant pour sélectionner plusieurs éléments.

Liaison de données au contrôle

Vous pouvez utiliser un contrôle serveur Web ListBox pour énumérer les options qui sont rendues disponibles sur la page à partir d'un contrôle de source de données. Chaque élément du contrôle ListBox correspond à un élément de la source de données, généralement un enregistrement individuel de données.

Le contrôle affiche un champ de la source. Vous pouvez, en option, lier le contrôle à un deuxième champ afin de définir la valeur d'un élément (qui n'est pas affichée).

Tout comme avec d'autres contrôles serveur, vous pouvez lier aux données les propriétés d'un contrôle, telles que la couleur ou la taille du contrôle. Pour plus d'informations, consultez Comment : remplir des contrôles serveur Web List à partir d'une source de données (Visual Studio).

Événements ListBox

Le contrôle ListBox déclenche l'événement SelectedIndexChanged lorsque l'utilisateur sélectionne un élément. Par défaut, cet événement ne provoque pas la publication (postback) de la page sur le serveur, mais vous pouvez forcer le contrôle à la publier immédiatement en affectant la valeur true à la propriété AutoPostBack.

Remarque :
La fonction de publication automatique exige que le navigateur prenne en charge ECMAScript (JScript ou JavaScript) et que les scripts soient activés sur le navigateur de l'utilisateur.