Supported PlatformsProject Types: Desktop Platforms: macOS, Windows, Linux
- For web applications, see WebTextField.
The standard editable text field used by desktop applications. A TextField control can contain one line of text, with one font, font size, and style. Use TextArea if you need multiple lines of text or styled text.
Execution order of MenuHandlers
The intrinsic control menu handlers (such as TextField.SelectAll) are handled after any user-defined menu handlers on the TextField subclass (if it was subclassed). This means that if you have a SelectAll handler on the Window of the TextField, it will no longer be called when the TextField has focus, because the TextField will now handle it first. In this situation, create a TextField subclass that defines its own SelectAll handler, and handle the desired behavior there.
Adding Text to a TextField
When appending text to a TextField, you may notice some flicker as the TextField redraws to show the new text. This will happen if you appended the Text property of the TextField like this:
This occurs because the entire contents of the TextField has to be redrawn. To avoid this flicker, call the AppendText method instead. Simply pass it the text to be appended. For example, this code reads an external text file into a TextField using the Read method of the Readable class interface. The text is read in groups of 1000 characters until the end-of-file is reached.
Dim i As Integer
Dim stream As BinaryStream
f = GetOpenFolderItem(FileTypes1.Text) // file type defined in File type set
If f <> Nil Then
stream = BinaryStream.Open(f, False)
Loop Until stream.EOF
TextFields store all text internally in Unicode, which is able to represent a mixture of characters from different writing systems. When you extract the text via the Text or SelText properties, this text is returned in UTF-8.
Changing the TextColor property for a read-only TextField on Windows does not change the color. It is native Windows behavior for the field text to remain black.
Using Class Constants
Set the alignment of the entire contents of the TextField by assigning a constant to the Alignment property. The following class constants are available:
|0||AlignDefault||The default alignment. Currently, the same as AlignLeft.|
For example, the following code in the Action event of a control array sets the alignment of the text in a TextField. The Action event is passed an index parameter that indicates which control was clicked.
Select Case Index
TextField1.Alignment = TextField.AlignDefault
TextField1.Alignment = TextField.AlignLeft
TextField1.Alignment = TextField.AlignCenter
TexField1.Alignment = TextField.AlignRight