OptionList_GetTopIndex Method
Description
This method retrieves the index of the first visible 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.
Return Values
Returns the following according to the situation:
- Integer specifying the index of the first visible option.
- Nil if the control is not found or is not visible.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_OptionList_GetTopIndex MyControlReference [as Reference]) |
An alternative convention is to identify the control by providing the project file, the dialog name and the control name:
| Copy Code |
|---|
(Odcl_OptionList_GetTopIndex ProjectFile [as String] DialogName [as String] ControlName [as String]) |
Applies For
Example
| Copy Code |
|---|
; Get the index of the first visible index (Setq rValue (Odcl_OptionList_GetTopIndex MyProject_MyForm_MyControl)) |