View source for API:ListBoxGetDataIndex

{{LuaApi|group=ListBox}}
Returns the data index shown in one of a ListBox's visible rows.

<pre>
dataIndex = ListBoxGetDataIndex(listBoxName, rowIndex)
</pre>

== Arguments ==
;listBoxName : <code>string</code> – Name of the ListBox.
;rowIndex : <code>number</code> – Number of the visible row, counted from 1 at the top of the list as it is currently scrolled.

== Returns ==
;dataIndex : <code>number</code> – The entry of the display order (see [[API:ListBoxSetDisplayOrder|ListBoxSetDisplayOrder]]) shown in that row. This is normally an index into the ListBox's data table.

== Details ==
* The scroll position is taken into account: when the list is scrolled down by 5 rows, row 1 shows display-order entry 6.
* If <code>rowIndex</code> is less than 1, or the row is past the end of the display order, the function returns no value (<code>nil</code>).
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

== Errors ==
* <code>Error in function call 'ListBoxGetDataIndex': Window %s does not exist</code>
* <code>Error in function call 'ListBoxGetDataIndex': Window %s is not a ListBox</code>

== Example ==
From <code>default/ea_auctionhousewindow/source/auctionwindow.lua</code>:
<pre>
local dataIndex = ListBoxGetDataIndex( RESULTS_LIST, row )
local rowIsSelected = (windowData.currentlySelectedRow == dataIndex)

ButtonSetPressedFlag(rowName,  rowIsSelected)
ButtonSetStayDownFlag(rowName, rowIsSelected)
</pre>

== See also ==
* [[API:ListBoxSetDisplayOrder|ListBoxSetDisplayOrder]]
* [[API:ListBoxSetVisibleRowCount|ListBoxSetVisibleRowCount]]