ObjectDCL Banner

OptionList_SetTopIndex Method

Description

This method will ensure the option is visible. If necessary the list will scroll.

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.
nIndex
Integer identifying the index of the option.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found, is not visible or there is no such option.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_OptionList_SetTopIndex 
		MyControlReference [as Reference]
		nIndex [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_OptionList_SetTopIndex
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer])

Applies For

OptionList.

Example

CopyCode imageCopy Code
; Make sure the fifth option is visible
(Odcl_OptionList_SetTopIndex MyProject_MyForm_MyControl 4)