| Navigation: Language Reference > 8 - Controls > Control Declarations >====== TEXT (declare a multi-line text control) ====== |    |
TEXT ,AT( )[,CURSOR( )] [,USE( )] [,LAYOUT( )] [,DISABLE] [,KEY( )] [,MSG( )] [,HLP( )] [,BOXED][,SKIP] [,FONT( )]
| [,REQ] [,FULL] [,SCROLL] [,ALRT( )] [,HIDE] [,READONLY] [,FLAT] [,DROPID( )] [,UPR] [,TRN] [,RTF] |
| [,TIP( )] | [, | HSCROLL | ] | [, | LEFT | ] | [,COLOR( )][,SINGLE][,RESIZE] [,EXTEND( )] | |
| VSCROLL | RIGHT | |||||||
| HVSCROLL | CENTER |
| TEXT | Places a multi-line data entry field on the WINDOW, TOOLBAR, or REPORT. |
| AT | Specifies the initial size and location of the control (PROP:AT). If omitted, default values are selected by the runtime library. |
| CURSOR | Specifies a mouse cursor to display when the mouse is positioned over the control (PROP:CURSOR). If omitted, the WINDOW's CURSOR attribute is used, else the Windows default cursor is used. Not valid in a REPORT. |
| USE | The label of the variable that receives the value entered into the control by the user (PROP:USE). |
| LAYOUT | Specifies the control's left-to-right or right-to-left display and entry orientation (PROP:LAYOUT) |
| DISABLE | Specifies the control appears dimmed when the WINDOW or APPLICATION opens (PROP:DISABLE). |
| KEY | Specifies an integer constant or keycode equate that immediately gives focus to the control (PROP:KEY). Not valid in a REPORT. |
| MSG | Specifies a string constant containing the text to display in the status bar when the control has focus (PROP:MSG). Not valid in a REPORT. |
| HLP | Specifies a string constant containing the help system identifier for the control (PROP:HLP). Not valid in a REPORT. |
| BOXED | Specifies a single-track border around a TEXT control, with the text at the top of the border (PROP:BOXED). This attribute only works if the TEXT control is transparent or the parent window does not have the GRAY attribute applied. |
| SKIP | Specifies the control receives input focus to enter text only with the mouse or accelerator key and does not retain focus (PROP:SKIP). In a REPORT, SKIP specifies not to print the control if the content is blank, and to move all following controls in the band upward to “fill in” the blank. |
| FONT | Specifies the display font for the control (PROP:FONT). |
| REQ | Specifies the control may not be left blank or zero (PROP:REQ). Not valid in a REPORT. |
| FULL | Specifies the control expands to occupy the entire size of the WINDOW for any missing AT attribute width or height parameter (PROP:FULL). Not valid in a REPORT. |
| SCROLL | Specifies the control scrolls with the window (PROP:SCROLL). Not valid in a REPORT. |
| ALRT | Specifies “hot” keys active for the control (PROP:ALRT). Not valid in a REPORT. |
| HIDE | Specifies the control does not appear when the WINDOW or APPLICATION is first opened (PROP:HIDE). UNHIDE must be used to display it. |
| READONLY | Specifies the control does not allow data entry (PROP:READONLY). Not valid in a REPORT. |
| FLAT | Specifies that the control does not have a 3D border drawn around it (PROP:FLAT). |
| DROPID | Specifies the control may serve as a drop target for drag-and-drop actions (PROP:DROPID). Not valid in a REPORT. |
| UPR | Specifies all upper case entry (PROP:UPR). |
| TIP | Specifies the text that displays as “balloon help” when the mouse cursor pauses over the control (PROP:ToolTip). Not valid in a REPORT. |
| HSCROLL | Specifies that a horizontal scroll bar is automatically added to the text field when any portion of the data lies horizontally outside the visible area (PROP:HSCROLL). Not valid in a REPORT. |
| VSCROLL | Specifies that a vertical scroll bar is automatically added to the text field when any of the data lies vertically outside the visible area (PROP:VSCROLL). Use this when the USE variable size is larger than the TEXT field size. |
| HVSCROLL | Specifies that both vertical and horizontal scroll bars are automatically added to the text field when any portion of the data lies outside the visible area. Not valid in a REPORT. |
| LEFT | Specifies that the text is left justified within the area specified by the AT attribute (PROP:LEFT). |
| RIGHT | Specifies that the text is right justified within the area specified by the AT attribute (PROP:RIGHT). |
| CENTER | Specifies that the text is centered within the area specified by the AT attribute (PROP:CENTER). |
| COLOR | Specifies a background color for the control (PROP:COLOR). |
| SINGLE | Specifies the control is only for single line data entry (PROP:SINGLE). This is specifically to allow use of TEXT controls instead of ENTRY for Hebrew or Arabic data entry. Not valid in a REPORT. |
| RESIZE | Specifies adjusting the print height for the control according to the actual content (PROP:RESIZE). Valid only in a REPORT. |
| TRN | Specifies the text or USE variable characters transparently display over the background (PROP:TRN). |
| RTF | Specifies that the contents of the text field supports Rich Text Format. |
| EXTEND | Specifies special document formatting information. This information contains a valid string of attributes that are assigned to a designated REPORT control for a given document type. Valid only in a REPORT. (See EXTEND) |
The TEXT control places a multi-line data entry field on the WINDOW (or TOOLBAR) at the position and size specified by its AT attribute. It is valid in Clarion Win32 Windows, and also for REPORT structures in both Clarion Win32 and Clarion#. The variable specified in the USE attribute receives the data entered when the user has completed data entry and moves on to another control. The entered data automatically “word-wraps” to fit in the text box.
The capacity of a TEXT control varies depending on the operating system.
TEXT controls populated in the Report Formatter always show a “flat” or two-dimensional border. In the Window Formatter, these controls will show a three-dimensional border if the window has a GRAY attribute, and the transparent (TRN) and flat (FLAT) attributes for the control are not enabled. The BOXED attribute must be active for any border to be drawn.
Events Generated:
| EVENT:Selected | The control has received input focus. |
| EVENT:Accepted | The user has completed data entry in the control. |
| EVENT:PreAlertKey | The user pressed an ALRT attribute hot key. |
| EVENT:AlertKey | The user pressed an ALRT attribute hot key. |
| EVENT:Drop | A successful drag-and-drop to the control. |
Example:
MDIChild WINDOW('Child One'),AT(0,0,320,200),MDI,MAX,HVSCROLL
TEXT,AT(0,0,40,40),USE(E1),ALRT(F10Key),CENTER
TEXT,AT(20,0,40,40),USE(E2),KEY(F10Key),HLP('Text4Help')
TEXT,AT(40,0,40,40),USE(E3),SCROLL,OVR,UPR
TEXT,AT(60,0,40,40),USE(E4),CURSOR(CURSOR:Wait),RIGHT
TEXT,AT(80,0,40,40),USE(E5),DISABLE,FONT('Arial',12)
TEXT,AT(100,0,40,40),USE(E6),HVSCROLL,LEFT
TEXT,AT(120,0,40,40),USE(E7),REQ,INS,CAP,MSG('Text Field 7')
END
CustRpt REPORT,AT(1000,1000,6500,9000),THOUS
Detail DETAIL,AT(0,0,6500,1000)
TEXT,AT(0,0,40,40),USE(E1)
TEXT,AT(100,0,40,40),USE(E6),FONT('Arial',12)
TEXT,AT(120,0,40,40),USE(E7),CAP
TEXT,AT(140,0,40,40),USE(E8),UPR
TEXT,AT(160,0,40,40),USE(E9),LEFT
TEXT,AT(180,0,40,40),USE(E10),RIGHT
TEXT,AT(200,0,40,40),USE(E11),CENTER
END
END
See Also: