ObjectDCL Banner

ListView_SetItemText Method

Description

This method will set the text of an item. If a ListView with a Report style is called the optional nColIndex may need to be used, otherwise it's not required for any other style of ListView.

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.
sNewText
String specifying the new text to apply.
nRowIndex
Integer specifying row index.
nColIndex
Integer specifying column index.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found, does not support this function or if there is no such row or column.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_ListView_SetItemText 
		MyControlReference [as Reference]
		sNewText [as String]
		nRowIndex [as Integer]
		[Optional] nColIndex [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_SetItemText
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		sNewText [as String]
		nRowIndex [as Integer]
		[Optional] nColIndex [as Integer])

Applies For

ListView.

Example

CopyCode imageCopy Code
; Update the text of the third row on the fourth column
(Odcl_ListView_SetItemText MyProject_MyForm_MyControl "Completed" 2 3)

See Also

ListView_AddItem, 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