BaseListBoxControl.TopIndex Property

Gets or sets the index of the first visible item in the list box control.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[Browsable(false)]
public virtual int TopIndex { get; set; }

VB.NET

<Browsable(False)>
Public Overridable Property TopIndex As Integer

Property Value

Type	Description
Int32	An integer value specifying the zero-based index of the top visible item.

Remarks

If total item height exceeds the list box control’s client area, end-users can scroll the control’s contents vertically. You can use the TopIndex property to obtain the index of the top visible item. Initially, the first item in the collection is at the top of the visible region of the control. Assigning a value to this property results in scrolling to the specified item.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TopIndex property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-synchronize-top-items-of-two-listboxcontrols-e3837/CS/WindowsApplication1/Form1.cs#L23

{
    int topIndex = (sender as ListBoxControl).TopIndex;
    listBoxControl1.TopIndex = topIndex;

VB.NET

how-to-synchronize-top-items-of-two-listboxcontrols-e3837/VB/Form1.vb#L21

Private Overloads Sub OnScroll(ByVal sender As Object, ByVal e As ScrollEventArgs) Handles myListBoxScrollHelper1.VScroll, myListBoxScrollHelper2.VScroll
    Dim topIndex As Integer = (TryCast(sender, ListBoxControl)).TopIndex
    listBoxControl1.TopIndex = topIndex