ListView_InsertItem (Report Style) Method

Description

This method inserts a new item anywhere in a ListView control and will also fill in the cells in the entire row according to how many columns have been setup. Using this method the very first cell under the first column can be specified to display an image from the image list. Use ListView_SetItemImage to set the icons of any column cell.

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.
nInsertRowIndex: Integer specifying the index where to insert the new row.
nImageIndex: Integer specifying the index of the image in the list defined at design for the control.
sText: String specifying the text to display on the first column.
sColTextX: String specifying the text to display for the Xth column.

Return Values

Returns the following according to the situation:

Integer specifying the index of the added row.
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_ListView_InsertItem MyControlReference [as Reference] nInsertRowIndex [as Integer] (list [Optional] nImageIndex [as Integer] sText [as String] sColText1 [as String] sColText2 [as String] sColText3 [as String] ... sColTextN [as String] ) )

Copy Code

(Odcl_ListView_InsertItem 
		MyControlReference [as Reference]
		nInsertRowIndex [as Integer]
		(list 
			[Optional] nImageIndex [as Integer]
			sText [as String]
			sColText1 [as String]
			sColText2 [as String]
			sColText3 [as String]
			...
			sColTextN [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_ListView_InsertItem ProjectFile [as String] DialogName [as String] ControlName [as String] nInsertRowIndex [as Integer] (list [Optional] nImageIndex [as Integer] sText [as String] sColText1 [as String] sColText2 [as String] sColText3 [as String] ... sColTextN [as String] ) )

Copy Code

(Odcl_ListView_InsertItem
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nInsertRowIndex [as Integer]
		(list 
			[Optional] nImageIndex [as Integer]
			sText [as String]
			sColText1 [as String]
			sColText2 [as String]
			sColText3 [as String]
			...
			sColTextN [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

ListView.

Example

Copy Code
; Insert an item with no image at the seventh position (Odcl_ListView_InsertItem MyProject_MyForm_MyControl 6 (list "Robert Duvall" "615-555-5555" "") )