TopIndex Property

Applies To

ComboBox control, ListBox control.

Description

Sets and returns the item that appears in the topmost position in the list.

Syntax

object.TopIndex [= Variant]

The TopIndex property syntax has these parts:

Part	Description

object	Required. A valid object.
Variant	Optional. The number of the list item that is displayed in the topmost position. The default is 0, or the first item in the list.

Settings

Returns the value –1 if the list is empty or not displayed.

Example

The following example identifies the top item displayed in a ListBox and the item that has the focus within the ListBox. This example uses the TopIndex property to identify the item displayed at the top of the ListBox and the ListIndex property to identify the item that has the focus. The user selects an item in the ListBox. The displayed values of TopIndex and ListIndex are updated when the user selects an item or when the user clicks the CommandButton.

To use this example, copy this sample code to the Declarations portion of a form. Make sure that the form contains:

A Label named Label1.
A TextBox named TextBox1.
A Label named Label2.
A TextBox named TextBox2.
A CommandButton named CommandButton1.

A ListBox named ListBox1.

Private Sub CommandButton1_Click()
    ListBox1.TopIndex = ListBox1.ListIndex
    TextBox1.Text = ListBox1.TopIndex
    TextBox2.Text = ListBox1.ListIndex
End Sub

Private Sub ListBox1_Change()
    TextBox1.Text = ListBox1.TopIndex
    TextBox2.Text = ListBox1.ListIndex
End Sub

Private Sub UserForm_Initialize()
    Dim i As Integer

    For i = 0 To 24
        ListBox1.AddItem "Choice " & (i + 1)
    Next i
    ListBox1.Height = 66
    CommandButton1.Caption = "Move to top of list"
    CommandButton1.AutoSize = True
    CommandButton1.TakeFocusOnClick = False
    
    Label1.Caption = "Index of top item"
    TextBox1.Text = ListBox1.TopIndex

    Label2. Caption = "Index of current item"
    Label2.AutoSize = True
    Label2.WordWrap = False
    TextBox2.Text = ListBox1.ListIndex
End Sub