ObjectDCL Banner

ListView_FillList (Report Style) Method

Description

This method will clear and fill a ListView 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.
sItemText
String specifying the text to display on the first column.
nImageIndex
Integer specifying the index of the image in the list defined at design for the control.
sColTextX
String specifying the text to display for the Xth column.
nImageIndexX
Integer specifying the index of the image in the list defined at design for the control for the Xth column.

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_ListView_FillList 
		MyControlReference [as Reference]
		(list 
			(list 
				sItemText [as String] 
				[Optional] nImageIndex [as Integer] 
				sColText1 [as String] 
				[Optional] nImageListIndex1 [as Integer]
				sColText2 [as String] 
				[Optional] nImageListIndex2 [as Integer]
				...
				sColTextN [as String] 
				[Optional] nImageListIndexN [as Integer]) 
			(list 
				sItemText [as String] 
				[Optional] nImageIndex [as Integer] 
				sColText1 [as String] 
				[Optional] nImageListIndex1 [as Integer]
				sColText2 [as String] 
				[Optional] nImageListIndex2 [as Integer]
				...
				sColTextN [as String] 
				[Optional] nImageListIndexN [as Integer]) 
			...
		)
	)

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_ListView_FillList
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		(list 
			(list 
				sItemText [as String] 
				[Optional] nImageIndex [as Integer] 
				sColText1 [as String] 
				[Optional] nImageListIndex1 [as Integer]
				sColText2 [as String] 
				[Optional] nImageListIndex2 [as Integer]
				...
				sColTextN [as String] 
				[Optional] nImageListIndexN [as Integer]) 
			(list 
				sItemText [as String] 
				[Optional] nImageIndex [as Integer] 
				sColText1 [as String] 
				[Optional] nImageListIndex1 [as Integer]
				sColText2 [as String] 
				[Optional] nImageListIndex2 [as Integer]
				...
				sColTextN [as String] 
				[Optional] nImageListIndexN [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

ListView.

Example

CopyCode imageCopy Code
; Clear and rebuild the list
(Odcl_ListView_FillList MyProject_MyForm_MyControl
	(list
		(list "Charles Monk" 0 "213-555-5555") 
		(list "Arthur Mongomery" 2 "644-555-5555") 
		)
	)

See Also

ListView_AddItem, ListView_AddItem (Report Style), ListView_Clear, ListView_CountItems, ListView_DeleteItem, ListView_DeleteItems, ListView_FillList, ListView_GetCount, ListView_GetItemData, ListView_GetItemImage, ListView_GetItemText, ListView_GetRowItems, ListView_InsertItem, ListView_InsertItem (Report Style) ListView_SetItemData, ListView_SetItemImage, ListView_SetItemText