ListBox.TopIndex Propriété

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Obtient ou définit l'index du premier élément visible dans ListBox.

public:
 property int TopIndex { int get(); void set(int value); };

[System.ComponentModel.Browsable(false)]
public int TopIndex { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.TopIndex : int with get, set

Public Property TopIndex As Integer

Valeur de propriété

Int32

Index de base zéro du premier élément visible dans le contrôle.

Attributs

BrowsableAttribute

Exemples

L’exemple de code suivant montre comment utiliser la propriété avec la SelectedIndex TopIndex propriété pour déplacer l’élément sélectionné en haut de la liste des éléments dans la zone d’affichage du ListBox. L’exemple montre également comment supprimer des éléments à l’aide de la RemoveAt méthode de la System.Windows.Forms.ListBox.ObjectCollection classe et comment effacer toute sélection d’élément à l’aide de la ClearSelected méthode. Le code déplace d’abord l’élément actuellement sélectionné en ListBox haut de la liste. Le code supprime ensuite tous les éléments avant l’élément actuellement sélectionné et efface toutes les sélections dans le ListBox. Cet exemple nécessite qu’un ListBox élément contenant soit ajouté à un formulaire et qu’un élément est actuellement sélectionné dans le ListBox.

private:
   void RemoveTopItems()
   {
      // Determine if the currently selected item in the ListBox 
      // is the item displayed at the top in the ListBox.
      if ( listBox1->TopIndex != listBox1->SelectedIndex )

      // Make the currently selected item the top item in the ListBox.
      listBox1->TopIndex = listBox1->SelectedIndex;

      // Remove all items before the top item in the ListBox.
      for ( int x = (listBox1->SelectedIndex - 1); x >= 0; x-- )
      {
         listBox1->Items->RemoveAt( x );
      }

      // Clear all selections in the ListBox.
      listBox1->ClearSelected();
   }

private void RemoveTopItems()
{
   // Determine if the currently selected item in the ListBox 
   // is the item displayed at the top in the ListBox.
   if (listBox1.TopIndex != listBox1.SelectedIndex)
      // Make the currently selected item the top item in the ListBox.
      listBox1.TopIndex = listBox1.SelectedIndex;

   // Remove all items before the top item in the ListBox.
   for (int x = (listBox1.SelectedIndex -1); x >= 0; x--)
   {
      listBox1.Items.RemoveAt(x);
   }

   // Clear all selections in the ListBox.
   listBox1.ClearSelected();
}

Private Sub RemoveTopItems()
   ' Determine if the currently selected item in the ListBox 
   ' is the item displayed at the top in the ListBox.
   If listBox1.TopIndex <> listBox1.SelectedIndex Then
      ' Make the currently selected item the top item in the ListBox.
      listBox1.TopIndex = listBox1.SelectedIndex
   End If
   ' Remove all items before the top item in the ListBox.
   Dim x As Integer
   For x = listBox1.SelectedIndex - 1 To 0 Step -1
      listBox1.Items.RemoveAt(x)
   Next x

   ' Clear all selections in the ListBox.
   listBox1.ClearSelected()
End Sub

Remarques

Initialement, l’élément avec la position d’index zéro (0) se trouve en haut de la région visible du ListBox. Si le contenu du ListBox fichier a été fait défiler, un autre élément peut se trouver en haut de la zone d’affichage du contrôle. Vous pouvez utiliser cette propriété pour obtenir l’index dans le ListBox.ObjectCollection cadre de l’élément ListBox actuellement positionné en haut de la région visible du contrôle. Vous pouvez également utiliser cette propriété pour positionner un élément dans la liste en haut de la région visible du contrôle.