ListBox_GetText Method
Description
This method will retrieve a requested list item.
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 desired item.
Return Values
Returns the following according to the situation:
- String indicating the text of the item.
- Nil if the control is not found, does not support this function or there is no such element.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_ListBox_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_ListBox_GetText ProjectFile [as String] DialogName [as String] ControlName [as String] nIndex [as Integer] ) |
Applies For
Example
| Copy Code |
|---|
; Get the text of the 3rd item (setq rValue (Odcl_ListBox_GetText MyProject_MyForm_MyControl 2)) |