ObjectDCL Banner

Grid_DeleteColumn Method

Description

This method will delete the specified column from the 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.
nColIndex
Integer specifying the column index.

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_DeleteColumn 
		MyControlReference [as Reference]
		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_DeleteColumn
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nColIndex [as Integer])

Remarks

A column can only be deleted if that column was not added using the properties wizard.

Applies For

EditableGrid.

Example

CopyCode imageCopy Code
; Delete the fourth column
(Odcl_Grid_DeleteColumn MyProject_MyForm_MyControl 3)

See Also

Grid_AddColumns, Grid_CalcColWidth, Grid_GetColumnCount, Grid_GetColumnImage, Grid_GetColumnItems, Grid_GetColWidth, Grid_SetColumnImage, Grid_SetColWidth, Grid_SortNumericItems, Grid_SortTextItems