ObjectDCL Banner

OptionList_AddList Method

Description

This method will add a list of options.

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.
Option
String identifying an option to add.

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_AddList 
		MyControlReference [as Reference]
		(list
			Option [as String]
			Option [as String]
			...))

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_AddList
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		(list
			Option [as String]
			Option [as String]
			...))

Applies For

OptionList.

Example

CopyCode imageCopy Code
; Add more options
(Odcl_OptionList_AddList MyProject_MyForm_MyControl (list "Option 1" "Option 2" "Option 3"))

See Also

OptionList_AddString, OptionList_Clear, OptionList_DeleteString, OptionList_GetCount, OptionList_InsertString