ObjectDCL Banner

Grid_GetItemCheck Method

Description

This method will indicate if a cell of style 1 - Check Boxes or 2 - Option Buttons has been checked off.

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:

  • Boolean specifying the state.
  • 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_GetItemCheck 
		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_GetItemCheck
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nRowIndex [as Integer]
		[Optional] nColIndex [as Integer])

Applies For

EditableGrid.

Example

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

See Also

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