ObjectDCL Banner

ListView_InsertItem Method

Description

This method inserts a new item anywhere in a ListView control.

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.

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:

CopyCode imageCopy Code
(Odcl_ListView_InsertItem 
		MyControlReference [as Reference]
		nInsertRowIndex [as Integer]
		[Optional] nImageIndex [as Integer]
		sText [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_ListView_InsertItem
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nInsertRowIndex [as Integer]
		[Optional] nImageIndex [as Integer]
		sText [as String])

Applies For

ListView.

Example

CopyCode imageCopy Code
; Insert a new row at the beginning of the list
(Odcl_ListView_InsertItem MyProject_MyForm_MyControl
	0 2 "Debit Card")

See Also

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