TEdit

A TEdit is a control with a single line of editable text. It is available from the Standard tab of the Component Palette.

Usage

You can add a TEdit text input field to your form by clicking on it in the Standard tab of the component palette and place it on your form with one click. You can now edit this single-line text field at run time.

If you want to use this text elsewhere, you can use it like every other String.

For example, if you have a TEdit Edit1 on your form, you can use myString := Edit1.Text;. To change the shown text in Edit1, you can use Edit1.Text := myString;.

If you want to display another text instead of the default text (e.g. Edit1) in a TEdit Edit1 at the start of your application, you can proceed as follows:

• Select the TEdit on your form with one click.
• Go to the properties tab in the Object Inspector.
• Select the property Text and change it in the neighbouring input field.
• In the same way, you can select the property Name and give the TEdit a better name.

Password input

You can also easily use a TEdit to enter passwords. Then instead of the actually entered Char a PasswordChar is displayed.

Little Example:

• Create a new GUI application with a TEdit Edit1 and a TButton Button1 on the form.
• In the Object Inspector set the property PasswordChar of Edit1 to am asterisk ( * ).
• In the event handler of OnClick of Button1 show the entered password: ShowMessage(Edit1.Text);.

TextHint

Have you used a GUI that has, for example, a Search Box where you can type in a search term. And when unused, that Search Box displays something like "Search Here" so you know what it is for ? Well, TEdit has a property called TextHint for that purpose. Set TextHint to some appropriate text and if the normal 'Text' is empty and the Control is not in use, your Search Here message is displayed. On most Widget Sets, the TextHint is automatically cleared once the user starts typing in there. The exception is GTK2/3, they like to clear things as soon as the Control gets focus.

The text from TextHint is displays a little greyer than normal text so the user is aware it is somehow special. Most people find this interface quite intuitive.

Requested Features

Embedding Button/Other Controls in TEdit

It's a WinAPI feature to allow embedding any sort of control into a TEdit.

Considerations.

• The feature is not supported by all Widgetsets natively. For example: for Gtk2/Gtk3 it's not possible, as GtkEntry is not derived from a container. The SpinEdit control is a special kind of control in Gtk2. (This is the main reason on why TSpinEdit has its own WS class).
• The placement of an embedded control (or controls) cannot be set by Left or Top properties (as normally happens). Instead the "Align" property should be used.

button1.Parent:=edit1;
button1.Width:=20;
button1.Align:=alRight;
button1.Constraints.MaxHeight:=18; //edit1.Height;

• The "text" entry field must be limited by some TEdit property

OR this should be done automatically by the widgetset.

Without such a limitation, the entered text goes "underneath" the embedded button.

If using pure WinAPI, this can be achieved by using an EM_SETMARGINS message:

Uses
  Windows, ...

...

  SendMessage(Edit1.Handle, EM_SETMARGINS, EC_LEFTMARGIN or EC_RIGHTMARGIN, MakeLParam(0, button1.Width))

The Delphi VCL does provide a Margins property, but it is not mapped to EM_SETMARGINS and has a different meaning in the VCL.

See also

• TEdit doc
• TMemo - A multiline text edit box
• TLabeledEdit - An edit field like a TEdit with a label
• TMaskEdit - An edit field with an edit mask
• TSpinEdit - An edit field for integers defined numbers range limits
• TFloatSpinEdit - An edit field for tiles floating-point numbers with defined numbers range limits
• TEditButton - An edit field like a TEdit with an attached button as a TSpeedBtn
• TFileNameEdit - An edit field with attached TOpenDialog, to enter a file name
• TDirectoryEdit - An edit field with attached TSelectDirectoryDialog, to enter a file path
• TDateEdit - An edit field with attached TCalendarDialog (calendar), to enter a date
• TCalcEdit - An input field with attached TCalculatorDialog (Calculator), to enter a number
• TTIEdit - An RTTI capable input field

From the Free Pascal wiki, page "TEdit", as it stood on 2022-12-06 after a change by Dbannon, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's Licensing page. If you have concerns about this material, message the admin.