nRow, nColNuméricoRequired
Row and column where the text area is placed. With PIXEL, coordinates start at the upper-left corner of the parent.
COMMANDPublished
@ ... GET MULTILINE
@ <nRow>, <nCol> GET [<oMultiGet> VAR] <uVar> MULTILINE [OF <oWnd>] [SIZE <nWidth>, <nHeight>] [WHEN <cbWhen>] [VALID <cbValid>] [READONLY] [NOBORDER] [NO VSCROLL]Creates a TMultiGet field for editing or displaying multiple lines of text.
Overview
The @ ... GET MULTILINE command creates a text area bound to a character variable. During compilation it is translated into the TMultiGet class New() constructor. By default, vertical scrolling is available when content exceeds the component height; it may also be read-only, borderless or created without vertical scrolling.
Syntax
@ <nRow>, <nCol> GET [<oMultiGet> VAR] <uVar> MULTILINE [OF <oWnd>] [SIZE <nWidth>, <nHeight>] [WHEN <cbWhen>] [VALID <cbValid>] [READONLY] [NOBORDER] [NO VSCROLL]Parameters
oMultiGet VARObjetoOptional
Variable receiving the TMultiGet object. When supplied, VAR must precede the edited variable.
uVarCaractereRequired
Character variable whose text is displayed and edited.
MULTILINECláusulaRequired
Selects the multiline control. TEXT and MEMO are accepted, but MULTILINE is recommended.
OF oWndObjetoOptional
Dialog, panel, folder or other owner container. OF is recommended.
SIZE nWidth, nHeightNuméricoOptional
Width and height of the text area.
WHEN cbWhenLógicoOptional
Condition determining whether the component may receive focus.
VALID cbValidLógicoOptional
Validation run when focus is lost; it must return .T. to allow leaving.
READONLYCláusulaOptional
Allows selection and copying but prevents text changes.
NOBORDER / NO BORDERCláusulaOptional
Creates the component without its standard visual border.
NO VSCROLLCláusulaOptional
Disables vertical scrolling even when more lines exist than can be displayed.
COLOR · SIZE · FONT · PIXELCláusulasOptional
Customize colors, dimensions, font and coordinate system.
Editing multiline notes
#Include "TOTVS.ch"
User Function ExGetMultiline()
Local oDlg
Local oNotes
Local cNotes := ""
Define Dialog oDlg Title "Order notes" ;
From 100, 100 To 380, 620 Pixel
@ 15, 20 Get oNotes Var cNotes ;
Multiline Size 250, 90 Of oDlg Pixel ;
Valid Len(AllTrim(cNotes)) <= 500
Activate Dialog oDlg Centered
ReturnExpected result
The user may enter line breaks. VALID limits the content to 500 characters before allowing focus to leave.
Read-only informational text
#Include "TOTVS.ch"
User Function ExTextoLeitura()
Local oDlg
Local cTexto := "Orientações:" + CRLF + ;
"1. Confira os dados." + CRLF + ;
"2. Confirme o processamento."
Define Dialog oDlg Title "Orientações" ;
From 0, 0 To 260, 520 Pixel
@ 15, 20 Get cTexto Multiline ReadOnly ;
Size 220, 75 Of oDlg Pixel NOBORDER
Activate Dialog oDlg Centered
ReturnExpected result
READONLY preserves selection and copying; NOBORDER provides a more discreet presentation.
- Include TOTVS.ch to make the command available to the compiler.
- The edited variable must be character; use regular GET for numeric or date values.
- Prefer MULTILINE over TEXT and MEMO for consistency.
- The vertical scroll bar appears automatically when required.
- Use READONLY for long text that users may select and copy.
- Prefer OF to explicitly identify the owner container.
- Official documentation notes that COLOR/COLORS support was added later; confirm AppServer and SmartClient versions in older environments.
- Without MULTILINE, TEXT or MEMO, the precompiler may generate a single-line TGet.
- When an object is supplied, omitting VAR makes the declaration invalid.
- NO VSCROLL may hide content that exceeds the available height.
- VALID and WHEN must return logical values.
- Without OF, the component is bound to the active window or dialog.
- Very large text may require application-specific limits, persistence and handling.