OptionList_InsertString Method
Description
This method will insert an option at the given index.
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 where to insert the option.
- Option
- String identifying an option to add.
Return Values
Returns the following according to the situation:
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_OptionList_InsertString MyControlReference [as Reference] nIndex [as Integer] Option [as String]) |
An alternative convention is to identify the control by providing the project file, the dialog name and the control name:
| Copy Code |
|---|
(Odcl_OptionList_InsertString ProjectFile [as String] DialogName [as String] ControlName [as String] nIndex [as Integer] Option [as String]) |
Applies For
Example
| Copy Code |
|---|
; Insert an option (Odcl_OptionList_InsertString MyProject_MyForm_MyControl 1 "Option 5") |
See Also
OptionList_AddList, OptionList_AddString, OptionList_Clear, OptionList_DeleteString, OptionList_GetCount