ObjectDCL Banner

Grid_GetColWidth Method

Description

This method will return the width of a column.

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 index of the column.

Return Values

Returns the following according to the situation:

  • Integer specifying the width.
  • Nil if the control is not found, does not support this function or there is no such column.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Grid_GetColWidth 
		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_GetColWidth
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nColIndex [as Integer])

Applies For

EditableGrid.

Example

CopyCode imageCopy Code
; Get the width of the third column
(setq rValue (Odcl_Grid_GetColWidth MyProject_MyForm_MyControl 2))

See Also

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