[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'StdCtrls' (#lcl)

TEdit

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Implements an edit control with a single line of text.

Declaration

Source position: stdctrls.pp line 951

type TEdit = class(TCustomEdit)

public

  property AutoSelected: Boolean;

  

Set to True when the text selection was made automatically.

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Alignment: TAlignment;

  

The horizontal alignment for the text in the control (left, right, or centered).

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoSize: Boolean;

  

Allows automatic adjustment of the size for the control, according to its content.

  property AutoSelect: Boolean;

  

Enables auto-selection of text when focused.

  property BidiMode: TBiDiMode;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderStyle: TBorderStyle;

  

Indicates the line style drawn as a border around the control.

  property CharCase: TEditCharCase;

  

Controls the character case applied to values entered in the control.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimum and maximum Width and Height for the control.

  property DoubleBuffered: Boolean;

  

Allows to reduce flicker in the painting of the control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragKind: TDragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property EchoMode: TEchoMode;

  

Allows to modify the text display, useful for entering passwords.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Font: TFont;

  

The font to be used for text display in this control.

  property HideSelection: Boolean;

  

Determines if selected text to be hidden when the control does not have focus.

  property MaxLength: Integer;

  

The maximum length of the value entered in Text, or 0 (zero) for unlimited length.

  property NumbersOnly: Boolean;

  

Indicates if the edit control accepts numeric values only.

  property ParentBidiMode: Boolean;

  

Allows to use the BiDiMode settings in the Parent control. Default is true.

  property OnChange: TNotifyEvent;

  

Event handler signalled when the text for the control is changed.

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEditingDone: TNotifyEvent;

  

Event handler signalled when editing is done.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus; This is a good place for checking the finished user input.

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property ParentColor: Boolean;

  

Uses the Color from the Parent control, when enabled.

  property ParentDoubleBuffered: Boolean;

  

Value from the DoubleBuffered property in a Parent control.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property ParentShowHint: Boolean;

  

If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.

  property PasswordChar: Char;

  

Allows obfuscation of the displayed text, showing all characters as PasswordChar.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control.

  property ReadOnly: Boolean;

  

Indicates if the user is prevented from changing the value for the Text in the control.

  property ShowHint: Boolean;

  

Enables the Hint display.

  property TabStop: Boolean;

  

Enables navigation using the Tab key.

  property TabOrder: TTabOrder;

  

Determines the sequence of control navigation when the user presses the Tab key.

  property Text: TCaption;

  

The text displayed and edited for the control.

  property TextHint: TTranslateString;

  

Default hint text shown when the Text property is empty and the control is not focused.

  property Visible: Boolean;

  

Allows the control, and all of its children, to be displayed or hidden.

end;

Inheritance

TEdit

  

Implements an edit control with a single line of text.

|

TCustomEdit

  

The base class for controls presenting editable text.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components which have an associated widget.

|

TComponent

?

TObject

Description

TEdit is a TCustomEdit descendant which implements an edit control presenting a single line of text. TEdit sets the visibility for properties and events introduced in the TCustomEdit ancestor, and does not introduce any new methods.

See also

HowToUseStdCtrls

  

How to use StdCtrls, ComCtrls or ExtCtrls.

TCustomEdit

  

The base class for controls presenting editable text.

TMemo

  

Control used to display and edit multi-line text.

TLabeledEdit

  

Labelled Edit is an Edit Box with a permanently attached Label.

TMaskEdit

  

TMaskEdit is an Edit box with characters masked out to avoid unauthorized reading.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.