ObjectDCL Banner

ListView_SetCurSel Method

Description

This method will force an item to be selected and will also scroll the control to ensure the item is displayed.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.
nRowIndex
Integer specifying row index. Pass -1 to clear the selection.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found, does not support this function or if there is no such row.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_ListView_SetCurSel 
		MyControlReference [as Reference]
		nRowIndex [as Integer])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_ListView_SetCurSel
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nRowIndex [as Integer])

Applies For

BlockList, ListView.

Example

CopyCode imageCopy Code
; Select the sixth row
(Odcl_ListView_SetCurSel MyProject_MyForm_MyControl 5)

See Also

ListView_GetSelCount, ListView_GetSelectedItems, ListView_GetSelectedNths