ListBox.TopIndex Propriedade

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Obtém ou define o índice do primeiro item visível no 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

Valor da propriedade

Int32

O índice baseado em zero do primeiro item visível no controle.

Atributos

BrowsableAttribute

Exemplos

O exemplo de código a seguir demonstra como usar a SelectedIndex propriedade com a TopIndex propriedade para mover o item selecionado no momento para a parte superior da lista de itens na área de exibição da ListBox. O exemplo demonstra ainda mais como remover itens usando o RemoveAt método da System.Windows.Forms.ListBox.ObjectCollection classe e como limpar toda a seleção de item usando o ClearSelected método. Primeiro, o código move o item selecionado no momento para a ListBox parte superior da lista. Em seguida, o código remove todos os itens antes do item selecionado no momento e limpa todas as seleções no ListBox. Este exemplo requer que um ListBox item contendo seja adicionado a um formulário e que um item esteja selecionado no ListBoxmomento.

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

Comentários

Inicialmente, o item com a posição do índice zero (0) está na parte superior da região visível do ListBox. Se o conteúdo do ListBox ter sido rolado, outro item poderá estar na parte superior da área de exibição do controle. Você pode usar essa propriedade para obter o índice dentro ListBox.ObjectCollection ListBox do item que está posicionado atualmente na parte superior da região visível do controle. Você também pode usar essa propriedade para posicionar um item na lista na parte superior da região visível do controle.