[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 278

type TMaskEdit = class(TCustomMaskEdit) end;

public

  property IsMasked: Boolean;

  property EditText: string;

published

  property Align: TAlign;

  

Used to align the control in one of four directions.

  property Alignment: TAlignment;

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoSelect: Boolean;

  

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

  property AutoSize: Boolean;

  

Allows to automatically adjust the size of the control, according to its content.

  property BiDiMode: TBiDiMode;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the border spacing for this control

  property BorderStyle: TBorderStyle;

  

Allows to show a border (line) around the control,

  property CharCase: TEditCharCase;

  

Allows to force the text into all upper or lower case.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this 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 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 MaxLength: Integer;

  

The maximum length of the text; zero for unlimited.

  property ParentBiDiMode: Boolean;

  

Allows to use the BiDiMode settings of Parent. Default is true.

  property ParentColor: Boolean;

  

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

  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 PopupMenu: TPopupMenu;

  

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

  property ReadOnly: Boolean;

  

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

  property ShowHint: Boolean;

  

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

  property TabOrder: TTabOrder;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property Visible: Boolean;

  

Allows to show or hide the control, and all of its children.

  property OnChange: TNotifyEvent;

  

Event handler for any change in text.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  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 when editing is done

  property OnEndDock: TEndDragEvent;

  

Notification handler for the end of a docking operation.

  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;

  property OnMouseLeave: TNotifyEvent;

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnStartDock: TStartDockEvent;

  

Event handler for the start of a docking operation.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property EditMask: string;

  

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

  property Text: TCaption;

  

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

  property TextHint: TTranslateString;

  property SpaceChar: Char;

  

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

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

  

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 associated with widgets.

|

TComponent

?

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.