ObjectDCL Banner

TextBox_GetFirstVisibleLine Method

Description

This method gets a line of text from a 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 representing the line number.
  • 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_GetFirstVisibleLine 
		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_GetFirstVisibleLine
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

TextBox.

Example

CopyCode imageCopy Code
; Get the index of the first visible line
(Setq rValue (Odcl_TextBox_GetFirstVisibleLine MyProject_MyForm_MyControl))