ObjectDCL Banner

OptionList_SetCurSel Method

Description

This method will select an option.

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 to select. 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 or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_OptionList_SetCurSel 
		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_SetCurSel
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer])

Applies For

OptionList.

Example

CopyCode imageCopy Code
; Select the first option
(Odcl_OptionList_SetCurSel MyProject_MyForm_MyControl 0)

See Also

OptionList_GetCurSel