MaskEdit unit

Defines classes, types, and constants used to implement a masked edit control.

maskedit.pp implements an masked edit control which can be used to format, validate, or obscure the text entered in the control. The following components are added to the Lazarus IDE component palette:

Additional Tab

TMaskEdit

maskedit.pp is part of the Lazarus Component Library ( LCL).

Classes and records

`EDBEditError`	class	Exception class raised for an error in a masked edit control.
`EInvalidCodePoint`	class	Exception raised when an error occurs while setting a UTF-8 Code Point in a String.
`EInvalidEditMask`	class	Exception type raised for an invalid mask value in an edit mask.
`EInvalidUtf8`	class	Ancestor for UTF-8 exceptions.
`TCustomMaskEdit`	class	The base class for TMaskEdit.
`TIntMaskRec`	record	Represents the type and literal used for a character in an edit mask.
`TMaskEdit`	class	TMaskEdit is an Edit box with characters masked out to avoid unauthorized reading.

Procedures and functions

`FormatMaskText`	function	Applies an edit mask to the specified string value.
`Register`	procedure	Registers component for use in the Lazarus IDE.
`SplitEditMask`	procedure	Separates fields in the edit mask into the arguments passed to the routine.

Types

`TInternalMask`	type	Array type used to represent edit mask symbols in TCustomMaskEdit.
`TMaskeditTrimType`	enumeration	Controls how the value in a masked edit control is trimmed.
`TMaskEditValidationErrorMode`	enumeration	Represents the action taken for an error in TMaskEdit validation.
`tMaskedType`	enumeration	Enumeration with values representing mask character types.

Constants

`cMask_AllChars`	constant	An optional UTF-8 character.
`cMask_AllCharsFixed`	constant	A required UTF-8 character.
`cMask_AlphaNum`	constant	An optional alphanumeric character.
`cMask_AlphaNumFixed`	constant	A required alphanumeric character.
`cMask_Binary`	constant	An optional binary character.
`cMask_BinaryFixed`	constant	A required binary character.
`cMask_DateSeparator`	constant	Inserts the date separator character.
`cMask_Hex`	constant	An optional hexadecimal character.
`cMask_HexFixed`	constant	A required hexadecimal character.
`cMask_HourSeparator`	constant	Inserts the hour separator char.
`cMask_Letter`	constant	Can contain an optional letter only.
`cMask_LetterFixed`	constant	Must contain a letter only.
`cMask_LowerCase`	constant	After this the chars are in lower case.
`cMask_NoLeadingBlanks`	constant	Causes leading blanks to be trimmed from the value.
`cMask_Number`	constant	An optional numeric character.
`cMask_NumberFixed`	constant	A required numeric character.
`cMask_NumberPlusMin`	constant	An optional numeric or sign character.
`cMask_SetEnd`	constant	Indicates the end of a set definition.
`cMask_SetNegate`	constant	Negates the following set definition.
`cMask_SetOptional`	constant	Indicates a set of optional characters allowed for a position in a mask.
`cMask_SetRange`	constant	Indicates that the character set definition uses a range of character values.
`cMask_SetStart`	constant	Indicates the start of a set definition.
`cMask_SpecialChar`	constant	After this you can set an arbitrary char.
`cMask_UpperCase`	constant	After this the chars are in upper case.
`DefaultBlank`	constant	Represents a blank character value in a mask.
`MaskFieldSeparator`	constant	Delimiter used between fields in a mask.
`MaskNoSave`	constant	Represents a character that is not stored in a mask.
`SEmptySet`	constant	Exception message used when an empty set is specified in an edit mask.
`SFoundChar_Invalid`	constant	Exception message used when an invalid mask character is found.
`SIllegalCharInSet`	constant	Exception message used when a mask character not in the ASCII character set is used.
`SIllegalRangeChar`	constant	Exception message used when more than one set range is used in an edit mask.
`SIndexOutOfRangeForFMask`	constant	Exception message used when a position in the internal mask is not valid.
`SInvalidCodePoint`	constant	Message displayed in the EInvalidCodePoint exception.
`SUnclosedSet`	constant	Exception message used when an unclosed set is found in an edit mask.

Uses

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.