Grid_SetItemData Method
Description
This method will set the associated item data for the indicated list item. The item data will only accept integer values.
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.
- nRowIndex
- Integer specifying row index.
- nUserData
- Integer specifying the user data.
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.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_Grid_SetItemData MyControlReference [as Reference] nRowIndex [as Integer] nUserData [as Integer]) |
An alternative convention is to identify the control by providing the project file, the dialog name and the control name:
| Copy Code |
|---|
(Odcl_Grid_SetItemData ProjectFile [as String] DialogName [as String] ControlName [as String] nRowIndex [as Integer] nUserData [as Integer]) |
Remarks
The item data can only be set per individual row and not per cell.
Applies For
Example
| Copy Code |
|---|
; Update the user-defined data of the fifth row (Odcl_Grid_SetItemData MyProject_MyForm_MyControl 4 1024) |
See Also
Grid_GetItemCheck, Grid_GetItemData, Grid_GetItemImage, Grid_GetItemText, Grid_SetItemCheck, Grid_SetItemDropList, Grid_SetItemImage, Grid_SetItemStyle, Grid_SetItemText