MaskBox (gb.form)

This control implements a masked editable field.

Constants

Bracket
Circle
Dash
Space
Square
Underscore

Properties

Filter	Return or set a LIKE regular expression that defines which characters are allowed to be inserted in the MaskBox.
Mask	Return or set the control mask.
Prompt
ShowDefault	Return or set if the MaskBox keep showing its default value when losing the focus.
Text

Action	Returns or sets the action string associated with the control.
Alignment	Returns or sets the aligment of the control.
Background	Returns or sets the background color used by the control.
Border	Returns or sets if the control has a border.
Cursor	Use this property for assigning a custom cursor to a control.
Design	Indicates that the control is in design mode.
Direction	Return or set the control text direction.
Drop	Returns or sets if a control accepts drops.
Enabled	Indicates that the control is enabled.
Expand	Returns or sets if a control will expand if included in a container that arranges its contents.
Font	Returns or sets the font used to draw text in the control.
Foreground	Returns or sets the foreground color used by the control.
H	A synonymous for the Height property.
Handle	Returns the internal X11 window handle of the control.
HasFocus	Returns whether the control has the focus.
Height	Returns or sets the height of the control.
Hovered	Returns whether the mouse cursor is inside the control.
Id	A synonymous for the Handle property.
Ignore	Returns or sets if a control must be ignored when its parent arranges its children.
Left	Returns or sets the position of the left border of the control relative to its parent.
Length	Returns the text length.
MaxLength	Returns or sets the maximum length of the text.
Mouse	Returns or sets the appearence of the cursor when it points inside the control.
Name	Returns or sets the name of the control.
Next	Returns the next control having the same parent.
NoTabFocus	Return or set if a control cannot be focused with the TAB key.
Parent	Returns the control container.
Password	Indicates if the MaskBox displays stars (or dots, or any adequate character) instead of the real text.
Placeholder	Return or set the placeholder text, i.e. the text displayed when the Text property is void.
PopupMenu	Return or set the name of the menu that will be popped-up when the user presses the right mouse button or the keyboard MENU key.
Pos	Returns or sets the cursor position, in characters from the beginning of the text.
Previous	Returns the previous control having the same parent.
Proxy	Return or set the "proxy" of a control.
ReadOnly	Indicates if the user can modify the text.
RightToLeft	Return if the control is right to left oriented.
ScreenX	Returns the position of the left border of the control in screen coordinates.
ScreenY	Returns the position of the top border of the control in screen coordinates.
Selected	Returns if some text is selected.
Selection	Returns an object used for managing the selected text.
Tag	Returns or sets the control tag.
Tooltip	Returns or sets the tooltip shown when the mouse stays on the control for a short time.
Top	Returns or sets the position of the top border of the control relative to its parent.
Tracking	Returns or sets if the control will receive MouseMove events.
Visible	Indicates if the control is visible or not.
W	A synonymous for the Width property.
Width	Returns or sets the width of the control.
Window	Returns the top-level window that contains the control.
X	Returns or sets the position of the left border of the control relative to its parent.
Y	Returns or sets the position of the top border of the control relative to its parent.

Methods

Clear

Clears the text.

CursorAt	Returns the cursor screen position from a text position.
Delete	Destroys the control.
Drag	Starts a drag & drop process.
Grab	Grab the keyboard and the mouse so that all keyboard and mouse events are received by the control.
Hide	Hides the control.
Insert	Inserts the specified text at the cursor position.
Lower	Sends the control to the background of its parent.
Move	Moves and/or resizes the control.
MoveScaled	Moves and/or resizes the control.
Raise	Sends the control to the foreground of its parent.
Refresh	Trigger a redraw of the control.
Reparent	Changes the container of a control.
Resize	Resizes the control.
ResizeScaled	Resizes the control.
Select	Define the selected text.
SelectAll
SetFocus	Gives the focus to the control.
Show	Shows the control.
Unselect	Unselects the selected text.

Events

Filter	This event is raised when the Char character is inserted.
Validate	This event is raised when the contents of the control changes so that you can validate the new contents.

Activate	Raised when the user presses the RETURN key (when the TextBox has focus).
Change	Raised when the text of the control changes.
Cursor	This event is raised when the cursor has moved.
DblClick	Raised when the user quickly clicks twice on the control.
Drag	This event is raised when the mouse enters the control during a drag & drop process.
DragLeave	This event is raised when the mouse leaves the control during a drag & drop operation.
DragMove	This event is raised while the mouse moves inside the control during a drag & drop process.
Drop	This event is raised when a drag is dropped in the control.
Enter	Raised when the mouse enters the control.
GotFocus	Raised when the control has got the focus.
KeyPress	Raised when a key is pressed while the control has the focus.
KeyRelease	Raised when a key is released while the control has the focus.
Leave	Raised when the mouse leaves the control.
LostFocus	Raised when the control has lost the focus.
Menu	Raised when the user clicks on the control with the right mouse button, or if it hits the MENU key.
MouseDown	Raised when a mouse button is pressed while the cursor is inside the control.
MouseDrag	This event is raised when a drag operation should be started.
MouseMove	Raised when the mouse moves inside the control while a mouse button is pressed.
MouseUp	Raised when a mouse button is depressed while the cursor is inside the control.
MouseWheel	This event is raised when the user moves or presses the mouse wheel while the mouse is inside the control.