ObjectDCL Banner

ListView_AddItem Method

Description

This method adds a new item to the end of 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.
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_AddItem 
		MyControlReference [as Reference]
		[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_AddItem
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		[Optional] nImageIndex [as Integer]
		sText [as String])

Applies For

ListView.

Example

CopyCode imageCopy Code
; Populate the list
(Odcl_ListView_AddItem MyProject_MyForm_MyControl
	2 "Debit Card")
(Odcl_ListView_AddItem MyProject_MyForm_MyControl
	3 "Credit Card")

See Also

ListView_AddItem (Report Style), 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, ListView_InsertItem (Report Style) ListView_SetItemData, ListView_SetItemImage, ListView_SetItemText