Aller au contenu principal

ListBox

Un contrôle ListBox offre une liste de choix parmi laquelle il est possible de sélectionner un ou plusieurs choix. Il gère automatiquement l'affichage avec ou sans barre de défilement. Les éléments affichés dans la liste peuvent être saisis au moment de la conception dans la fenêtre des propriétés ou modifiés par programmation. Les éléments de la liste sont gérés sous forme de collection via la propriété Items et sont généralement des chaînes de caractères. Le premier élément de la liste est à l'index 0.

PropriétéTypeDescription
propriété
(Name)
Indique le nom utilisé pour identifier l’objet. Préfixe : lst Exemple : lstExemple
propriété
Enabled
boolObtient ou définit une valeur indiquant si le contrôle est activé ou non.
propriété
Visible
boolObtient ou définit une valeur indiquant si le contrôle est visible ou masqué.
propriété
Anchor
Définit les bords du conteneur auquel le contrôle est lié. Lorsqu'un contrôle est ancré à un bord, la distance entre le bord le plus proche du contrôle et le bord spécifié reste constante. Pour ancrer une liste, il faut définir les 3 propriétés suivantes :
- FormBorderStyle : Sizable
MaximumSize : la hauteur et la largeur maximales
MinimumSize : la hauteur et la largeur minimales
propriété
ScrollAlwaysVisible
boolPar défaut, les barres de défilement sont visibles seulement si c'est nécessaire.
propriété
Items
CollectionContient les éléments de la zone de liste. Les items de la liste sont des objets. Pour obtenir une variable de type chaine, il faut convertir l'objet.
string premierObjet = (string)lstExemple.Items[0];
Pour plus d'informations, consultez les collections associées à une zone de liste.
propriété
Items.Count
intIndique le nombre d'éléments de la collection Items.
int nombreItems = lstExemple.Items.Count;
La variable nombreItems contient 0, s'il n'y a pas d'items dans la collection.
propriété
SelectionMode
Indique le mode de sélection des éléments de la liste.
- None : aucune sélection possible
- One : un seul item peut être sélectionné ou désélectionné par un clic de souris
- MultiSimple (ctrl ) et MultiExtended (shift, ctrl) : plusieurs items peuvent être sélectionnés.
L'énumération SelectionMode offre les choix de mode de sélection.
lstExemple.SelectionMode = SelectionMode.MultiSimple;
propriété
SelectedIndex
intObtient ou définit l'index de l'item sélectionné dans la liste.
- Pour obtenir l'index de l'élément sélectionné :
int indexSélectionné = lstExemple.SelectedIndex;
Si aucun élément n'est sélectionné, alors indexSélectionné est égal à -1.
- Pour sélectionner le 5e item de la liste :
lstExemple.SelectedIndex = 4;
Pour dé-sélectionner les items sélectionnés :
lstExemple.SelectedIndex = -1;
propriété
SelectedItem
Obtient ou définit la référence vers l'objet sélectionné dans la liste.
string élémentSélectionné = lstExemple.SelectedItem;
propriété
Sorted
boolObtient ou définit la valeur indiquant si les éléments dans la liste sont en ordre alphabétique.
lstExemple.Sorted = true;
propriété
Text
stringObtient la chaîne de caractères de l'item sélectionné.
string itemChoisi = lstExemple.Text;
MéthodeDescription
méthode
SetSelected(int index, bool value)
Sélectionne ou efface la sélection pour l'item dont l'index est spécifié.
// Sélectionner les items dont l'index est pair.
for (int index = 0; index < lstExemple.Items.Count; index += 2)
{
lstExemple.SetSelected(index, true);
}
méthode
Items.Add(object item)
Ajoute des éléments à la collection Items. Ils sont ajoutés à la fin de la liste sauf si la propriété Sorted est à true.
string  uneChaine = "Allo tout le monde";
lstExemple.Items.Add (uneChaine);
lstExemple.Items.Add ("Coucou");
méthode
Items.Clear()
Supprime les éléments de la collection Items. Le nombre d'éléments (propriété Count) devient 0.
 lstExemple.Items.Clear()
méthode
bool Items.Contains(object value)
Détermine si l'élément spécifié réside dans la collection. Retourne true si l'élément est présent, sinon false.
bool estPrésent = lstExemple.Items.Contains("Coucou");
méthode
Items.Insert(int index, object item)
Insère un élément dans la liste à l'index spécifié.
lstExemple.Items.Insert ("Coucou");
méthode
Items.Remove(object value)
Supprime l'objet spécifié de la collection Items.
lstExemple.Items.Remove("Coucou");
méthode
Items.RemoveAt(int index)
Supprime l'élément à l'index spécifié de la collection Items.
lstExemple.Items.RemoveAt(0); // Supprime le premier élément de la liste.

int indexSelectionné = lstExemple.SelectedIndex
lstExemple.Items.RemoveAt(indexSelectionné); // Supprime l'élément sélectionné.