ObjectDCL Banner

Grid_GetItemImage Method

Description

This method will retrieve the image of an item in a EditableGrid 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.
nRowIndex
Integer specifying row index.
nColIndex
Integer specifying column index.

Return Values

Returns the following according to the situation:

  • Integer specifying the index of the picture in the list defined at design time.
  • 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_Grid_GetItemImage 
		MyControlReference [as Reference]
		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_Grid_GetItemImage
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nRowIndex [as Integer]
		[Optional] nColIndex [as Integer])

Remarks

This method is not available for the BlockList control.

Applies For

EditableGrid.

Example

CopyCode imageCopy Code
; Get the image of the second column of the first row
(setq rValue (Odcl_Grid_GetItemImage MyProject_MyForm_MyControl 0 1))

See Also

Grid_GetItemCheck, Grid_GetItemData, Grid_GetItemText, Grid_SetItemCheck, Grid_SetItemData, Grid_SetItemDropList, Grid_SetItemImage, Grid_SetItemStyle, Grid_SetItemText