ObjectDCL Banner

Grid_CancelItemEdit Method

Description

This method will cancel the editing of a cell. This is useful when you wish to ensure that some items may be edited while others may not.

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.

Return Values

Returns the following according to the situation:

  • T when successful.
  • 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_CancelItemEdit 
		MyControlReference [as Reference])

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_CancelItemEdit
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

EditableGrid.

Example

CopyCode imageCopy Code
; Cancel label editing if any is occurring
(Odcl_Grid_CancelItemEdit MyProject_MyForm_MyControl)