Grid_FillList Method

Description

This method will clear and fill a EditableGrid control with multiple rows and will fill in the cells in each row according to how many columns have been previously setup.

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.
sItemTextX: String specifying the text to display on the column.
nImageIndexX: Integer specifying the index of the image in the list defined at design for the control.

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:

Copy Code
(Odcl_Grid_FillList MyControlReference [as Reference] (list (list sItemText1 [as String] [Optional] nImageIndex1 [as Integer] sItemText2 [as String] [Optional] nImageIndex2 [as Integer] ... sItemTextN [as String] [Optional] nImageIndexN [as Integer] ) (list sItemText1 [as String] [Optional] nImageIndex1 [as Integer] sItemText2 [as String] [Optional] nImageIndex2 [as Integer] ... sItemTextN [as String] [Optional] nImageIndexN [as Integer] ) ... ) )

Copy Code

(Odcl_Grid_FillList 
		MyControlReference [as Reference]
		(list 
			(list 
				sItemText1 [as String]
				[Optional] nImageIndex1 [as Integer]
				sItemText2 [as String]
				[Optional] nImageIndex2 [as Integer]
				...
				sItemTextN [as String]
				[Optional] nImageIndexN [as Integer]
			)
			(list 
				sItemText1 [as String]
				[Optional] nImageIndex1 [as Integer]
				sItemText2 [as String]
				[Optional] nImageIndex2 [as Integer]
				...
				sItemTextN [as String]
				[Optional] nImageIndexN [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_Grid_FillList ProjectFile [as String] DialogName [as String] ControlName [as String] (list (list sItemText1 [as String] [Optional] nImageIndex1 [as Integer] sItemText2 [as String] [Optional] nImageIndex2 [as Integer] ... sItemTextN [as String] [Optional] nImageIndexN [as Integer] ) (list sItemText1 [as String] [Optional] nImageIndex1 [as Integer] sItemText2 [as String] [Optional] nImageIndex2 [as Integer] ... sItemTextN [as String] [Optional] nImageIndexN [as Integer] ) ... ) )

Copy Code

(Odcl_Grid_FillList
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		(list 
			(list 
				sItemText1 [as String]
				[Optional] nImageIndex1 [as Integer]
				sItemText2 [as String]
				[Optional] nImageIndex2 [as Integer]
				...
				sItemTextN [as String]
				[Optional] nImageIndexN [as Integer]
			)
			(list 
				sItemText1 [as String]
				[Optional] nImageIndex1 [as Integer]
				sItemText2 [as String]
				[Optional] nImageIndex2 [as Integer]
				...
				sItemTextN [as String]
				[Optional] nImageIndexN [as Integer]
			)
			...
		)
	)

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

EditableGrid.

Example

Copy Code
; Clear the list and add this entry (Odcl_Grid_FillList MyProject_MyForm_MyControl (list (list "Robert Duvall" 2 "Diane Montreuil" "Sean Connery") ) )