ListView.TopItem Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the first visible item in the control.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

<BrowsableAttribute(False)>
Public Property TopItem As ListViewItem

Property Value

Type: System.Windows.Forms.ListViewItem

A ListViewItem that represents the first visible item in the control.

Exception Condition
InvalidOperationException

The View property is set to LargeIcon, SmallIcon, or Tile.

Initially, the item with the index position of zero (0) is at the top of the ListView control. If the ListView control contents are scrolled, a different item can be at the top of the control. You can use this property to indicate or determine which item is visible at the top of the ListView control. The value of the TopItem property will not always persist, depending on where the desired top item is in the list view.

The number of items visible in a ListView control at any time depends on the height of the list view and the size of the items it contains. If the items exceed the height of the list view, the items will continue onto multiple pages, which the user can scroll through. If you set the TopItem property to an item in the last page of the ListView, the item will automatically be scrolled into view; however, TopItem will be set to the actual top item of the last page.

To ensure that a specific item is in the visible region of the control (but not necessarily in the top position), use the EnsureVisible method.

System_CAPS_noteNote

Setting this property has no effect when the Scrollable property value is false.

Setting this property is not supported in versions of the .NET Framework prior to version 2.0.

The following code example demonstrates resetting the style of a ListViewItem object's subitems through the use of the TopItem property and the ListViewItem.ListViewSubItem.ResetStyle method. To run the example, paste the following code into a form containing a button named Button1 and call the InitializeListView method in the form's constructor or Load event handler.


' Declare the Listview object.
Friend WithEvents myListView As System.Windows.Forms.ListView

' Initialize the ListView object with subitems of a different
' style than the default styles for the ListView.
Private Sub InitializeListView()

    ' Set the Location, View and Width properties for the 
    ' ListView object. 
    myListView = New ListView
    With (myListView)
        .Location = New System.Drawing.Point(20, 20)

        ' The View property must be set to Details for the 
        ' subitems to be visible.
        .View = View.Details
        .Width = 250
    End With

    ' Each SubItem object requires a column, so add three columns.
    Me.myListView.Columns.Add("Key", 50, HorizontalAlignment.Left)
    Me.myListView.Columns.Add("A", 100, HorizontalAlignment.Left)
    Me.myListView.Columns.Add("B", 100, HorizontalAlignment.Left)

    ' Add a ListItem object to the ListView.
    Dim entryListItem As ListViewItem = myListView.Items.Add("Items")

    ' Set UseItemStyleForSubItems property to false to change 
    ' look of subitems.
    entryListItem.UseItemStyleForSubItems = False

    ' Add the expense subitem.
    Dim expenseItem As ListViewItem.ListViewSubItem = _
        entryListItem.SubItems.Add("Expense")

    ' Change the expenseItem object's color and font.
    expenseItem.ForeColor = System.Drawing.Color.Red
    expenseItem.Font = New System.Drawing.Font _
        ("Arial", 10, System.Drawing.FontStyle.Italic)

    ' Add a subitem called revenueItem 
    Dim revenueItem As ListViewItem.ListViewSubItem = _
        entryListItem.SubItems.Add("Revenue")

    ' Change the revenueItem object's color and font.
    revenueItem.ForeColor = System.Drawing.Color.Blue
    revenueItem.Font = New System.Drawing.Font _
        ("Times New Roman", 10, System.Drawing.FontStyle.Bold)

    ' Add the ListView to the form.
    Me.Controls.Add(Me.myListView)
End Sub

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click

    ' Use the ListView.TopItem property to access the SubItems
    ' and then reset their appearance.
    myListView.TopItem.SubItems(1).ResetStyle()
    myListView.TopItem.SubItems(2).ResetStyle()
End Sub

.NET Framework
Available since 1.1
Return to top
Show: