ObjectDCL Banner

Grid_ShowTextBox Method

Description

This method will activate a text box to edit a cell. The style argument accepts a numeric value that indicated the style of the text box to be used.

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.
nStyle
Integer specifying the new style to apply. The valid values are:
  • 6 - Strings
  • 7 - AngleUnits
  • 8 - Integers
  • 9 - Units
  • 10 - UpperCase
  • 11 - LowerCase
  • 12 - Password
  • 13 - MultiLine
  • 14 - Currency
  • 15 - Date
  • 16 - Time
  • 17 - Percentage

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

Remarks

If the style does not match the pre-assigned value for the cell or column, then the pre-assigned value will be used.

Applies For

EditableGrid.

Example

CopyCode imageCopy Code
; Show the text box on the third row on the fourth column
(Odcl_Grid_ShowTextBox MyProject_MyForm_MyControl 2 3 12)

See Also

Grid_ShowComboBox, Grid_ShowEllipsesButton, Grid_ShowImageComboBox, Grid_ShowItemDlg, Grid_ShowPickButton