ObjectDCL Banner

Grid_SetItemCheck Method

Description

This method will set a cell of style 1 - Check Boxes or 2 - Option Buttons as checked or unchecked.  

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.
bChecked
Boolean specifying the state. T for checked and Nil for unchecked.

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_Grid_SetItemCheck 
		MyControlReference [as Reference]
		nRowIndex [as Integer]
		nColIndex [as Integer]
		bChecked [as Boolean])

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_SetItemCheck
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nRowIndex [as Integer]
		nColIndex [as Integer]
		bChecked [as Boolean])

Applies For

EditableGrid.

Example

CopyCode imageCopy Code
; Update the state of the third row on the fourth column
(Odcl_Grid_SetItemCheck MyProject_MyForm_MyControl 2 3 T)

See Also

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