ObjectDCL Banner

ListBox_AddList Method

Description

This method will add a list of strings to the specified ListBox.

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.
sStringX
String specifying the text of an entry to add.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found or does not support this function.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_ListBox_AddList 
		MyControlReference [as Reference]
		(list 
			sItemText1 [as String]
			sItemText2 [as String]
			... 
			sItemTextN [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_ListBox_AddList
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		(list 
			sItemText1 [as String]
			sItemText2 [as String]
			... 
			sItemTextN [as String]
		)
	)

Remarks

Please create lists as follows using the list keyword: 

(list (list x y ...) (list x y ...) ...)

It seems that ObjectARX does not always handle lists created as follows: 

'(x y ...) (x y ...) ...  

Applies For

ListBox.

Example

CopyCode imageCopy Code
; Add to the list
(Odcl_ListBox_AddList MyProject_MyForm_MyControl
	(list
		"Orange"
		"Apple"
		"Pear"
	)

See Also

ListBox_AddString, ListBox_Clear, ListBox_DeleteString, ListBox_GetCount, ListBox_GetItemData, ListBox_InsertString, ListBox_SetItemData