ObjectDCL Banner

TextBox_GetLineCount Method

Description

This method counts the number of lines in a multiple-line TextBox.

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:

  • Integer describing the number of lines of text.
  • Nil if the control is not found or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_TextBox_GetLineCount 
		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_TextBox_GetLineCount
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

TextBox.

Example

CopyCode imageCopy Code
; Get the number of lines
(Setq rValue (Odcl_TextBox_GetLineCount MyProject_MyForm_MyControl))

See Also

TextBox_GetLine, TextBox_GetLineLength, TextBox_LineScroll