Display an TRADIUM styled input box where the user can enter a special formatted text. Pressing the OK button returns the string entered. Pressing the Cancel button returns a null string.
Parameter
| Description
|
Prompt$
| Use this string value as the prompt in the input box.
|
Title$
| Use this string value as the title of the input box. If this is omitted then the input box does not have a title.
Also, alternate captions for the button(s) can be used by adding a vertical bar sign ("|") and a caption for each button.
|
Default$
| Use this string value as the initial value in the input box. The initial value must match the Mask.
|
XPos
| When the dialog is put up the left edge will be at this screen position. If this is omitted then the dialog will be centered.
|
YPos
| When the dialog is put up the top edge will be at this screen position. If this is omitted then the dialog will be centered.
|
Mask
| A combination of special characters, marking up a special formatted entry box. See formatting table below.
If omitted, the input box will not use any formatting characters but will limit the maximum input length to 64 characters.
|
HelpFile
| For use with compiled .hlp files. Specify path and filename.
|
Context
| For use with compiled .hlp files. specify the context ID for context sensitive help functions when pressing F1.
|
Masking element
| Description
|
0
| Digit, required. This element will accept any single digit between 0 and 9.
|
9
| Digit or space, optional.
|
#
| Digit or space, optional. If this position is blank in the mask, it will be rendered as a space in the Text property. Plus (+) and minus (-) signs are allowed.
|
L
| Letter, required. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z] in regular expressions.
|
?
| Letter, optional. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z]? in regular expressions.
|
&
| Character, required. If the AsciiOnly property is set to true, this element behaves like the "L" element.
|
C
| Character, optional. Any non-control character. If the AsciiOnly property is set to true, this element behaves like the "?" element.
|
A
| Alphanumeric, optional. If the AsciiOnly property is set to true, the only characters it will accept are the ASCII letters a-z and A-Z.
|
a
| Alphanumeric, optional. If the AsciiOnly property is set to true, the only characters it will accept are the ASCII letters a-z and A-Z.
|
.
| Decimal placeholder. The actual display character used will be the decimal symbol appropriate to the format provider, as determined by the system's settings.
|
,
| Thousands placeholder. The actual display character used will be the thousands placeholder appropriate to the format provider, as determined by the system's settings.
|
:
| Time separator. The actual display character used will be the time symbol appropriate to the format provider, as determined by the system's settings.
|
/
| Date separator. The actual display character used will be the date symbol appropriate to the format provider, as determined by the system's setttings.
|
$
| Currency symbol. The actual character displayed will be the currency symbol appropriate to the format provider, as determined by the system's settings.
|
| < | Shift down. Converts all characters that follow to lowercase.
|
>
| Shift up. Converts all characters that follow to uppercase.
|
|
| Disable a previous shift up or shift down.
|
\
| Escape. Escapes a mask character, turning it into a literal. "\\" is the escape sequence for a backslash.
|
All other characters
| Literals. All non-mask elements will appear as themselves within MaskedTextBox. Literals always occupy a static position in the mask at run time, and cannot be moved or deleted by the user.
|