OptionList_GetText Method
Description
This method will retrieve the text of the given 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.
Return Values
Returns the following according to the situation:
- String specifying the number of options.
- Nil if the control is not found, is not visible or there is no option at that index.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_OptionList_GetText 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:
| Copy Code |
|---|
(Odcl_OptionList_GetText ProjectFile [as String] DialogName [as String] ControlName [as String] nIndex [as Integer]) |
Applies For
Example
| Copy Code |
|---|
; Get the text of the first option (Setq rValue (Odcl_OptionList_GetText MyProject_MyForm_MyControl 0)) |