ObjectDCL Banner

Grid_GetColumnItems Method

Description

This method will return a list containing the strings of a specified column in a 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 index of the column.

Return Values

Returns the following according to the situation:

  • List of strings specifying the items for every row of the column.
  • 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_GetColumnItems 
		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_GetColumnItems
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nColIndex [as Integer])

Applies For

EditableGrid.

Example

CopyCode imageCopy Code
; Get the items for the second column
(setq rValue (Odcl_Grid_GetColumnItems MyProject_MyForm_MyControl 1))

See Also

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