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

TMaskEdit

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

TMaskEdit - an Edit box with characters masked out to avoid unauthorised reading

Declaration

Source position: maskedit.pp line 268

type TMaskEdit = class(TCustomMaskEdit)

public

  property IsMasked;

  property EditText;

published

  property Align;

  

Used to align the control in one of four directions.

  property Anchors;

  

The set of anchor definitions for this control

  property AutoSelect;

  

AutoSelect : if True, the edit control will select all its text when it receives focus or when the Enter key is pressed.

  property AutoSize;

  

Whether auto-size is to be used

  property BiDiMode;

  

BiDiMode - enabling bi-directional writing

  property BorderSpacing;

  

Determines the border spacing for this control

  property BorderStyle;

  

BorderStyle - none, or single

  property CharCase;

  

CharCase - rules for what case to use (upper or lower) to display text

  property Color;

  

Determine the colour for the current control

  property Constraints;

  

Determine Constraints (max and min height and width) for this control

  property DragCursor;

  

DragCursor - the style of cursor to be used during the Drag process

  property DragKind;

  

DragKind - what sort of dragging? Drag or Dock

  property DragMode;

  

DragMode - whether manual or automatic

  property Enabled;

  

Whether the control is Enabled (read/write). If not, it usually appears 'greyed-out'

  property Font;

  

The font to be used for text in this control (read/write).

  property MaxLength;

  

MaxLength: maximum length allowed for text string

  property ParentBiDiMode;

  

ParentBiDiMode - does the control follow the BiDiMode settings of its parent?

  property ParentColor;

  

ParentColor - should the control have the same colour as the parent? Default is true

  property ParentFont;

  

ParentFont - should the control use the same font as the parent? Default is true

  property ParentShowHint;

  

ParentShowHint - does the control adopt the same hinting behaviour as its parent? Default is true

  property PopupMenu;

  

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

  property ReadOnly;

  

ReadOnly - the contents of the edit box may only be read, not written or erased

  property ShowHint;

  

Flag to determine: Is hint to be displayed for this control?

  property TabOrder;

  

The place this control occupies in the list of tabs

  property TabStop;

  

Is the control in the sequence of controls accessed by successive presses of the Tab key?

  property Visible;

  

Visible - can the control be seen?

  property OnChange;

  

OnChange - event handler for any change in text

  property OnClick;

  

Event Handler for mouse click

  property OnDblClick;

  

Event Handle for mouse double-click

  property OnDragDrop;

  

Event handler for the drop of a control onto this control.

  property OnDragOver;

  

Event handler for the case when a control is dragged over another control

  property OnEditingDone;

  

Event handler when editing is done

  property OnEndDock;

  

Event handler for the end of a docking operation

  property OnEndDrag;

  

Event handler for the end of a dragging process

  property OnEnter;

  

OnEnter - event handler for when the mouse enters the control, and the control receives focus

  property OnExit;

  

OnExit - event handler for when the mouse leaves the control and it loses focus

  property OnKeyDown;

  

OnKeyDown - event handler for instance when key is down while control has focus

  property OnKeyPress;

  

OnKeyPress - event controller for a key being pressed while the control has focus. To properly handle national chars use UTF8KeyPress instead.

  property OnKeyUp;

  

OnKeyUp - event handler for instance when a key is up (not pressed) while the control has focus

  property OnMouseDown;

  

Event handler for when a mouse button is pressed down

  property OnMouseEnter;

  property OnMouseLeave;

  property OnMouseMove;

  

Event handler for mouse movement within the current control

  property OnMouseUp;

  

Event handler for when the mouse button is released, ie "up"

  property OnStartDock;

  

Event handler for the start of a docking operation

  property OnStartDrag;

  

Event handler for start of dragging operation

  property OnUTF8KeyPress;

  

UTF8KeyPress - event controller for a key being pressed while the control has focus.

  property EditMask;

  

EditMask - the sequence of characters used to obscure the string being typed (typically a sequence of asterisks)

  property Text;

  

The Text string that is to be masked (or not)

  property SpaceChar;

  

SpaceChar - the character that is to be used as a Space character

end;

Inheritance

TMaskEdit

  

TMaskEdit - an Edit box with characters masked out to avoid unauthorised reading

|

TCustomMaskEdit

  

TCustomMaskEdit - base class for TMaskEdit, an Edit box with characters masked out to avoid unauthorised reading

|

TCustomEdit

  

TCustomEdit : the base type from which the TEdit Box is derived.

|

TWinControl

|

TControl

|

TLCLComponent

  

TLCLComponent - base class for LCL components

|

TComponent,IUnknown,IInterfaceComponentReference

|

TPersistent

|

TObject

Description

Mask Edit: Displays an Edit Box with the input text masked by a selected character specified by PasswordChar, usually an asterisk, or by EditMask (a complete string), specified in TCustomMaskEdit.
Useful for inputting passwords etc.

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