ObjectDCL Banner

TextBox_GetLine Method

Description

This method gets the text of any tree item.

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.
LineNumber
Integer specifying the line number.

Return Values

Returns the following according to the situation:

  • String describing the text of the that line.
  • 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_GetLine 
		MyControlReference [as Reference]
		LineNumber [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_TextBox_GetLine
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		LineNumber [as Integer])

Applies For

TextBox.

Example

CopyCode imageCopy Code
; Get the text of the second line
(Setq rValue (Odcl_TextBox_GetLine MyProject_MyForm_MyControl 1))

See Also

TextBox_GetLineCount, TextBox_GetLineLength