- Numeric controls (except for the currency controls)
- Currency controls
- Currency + Euro controls
- Date controls
- Time controls
- DateTime controls
- Duration controls
- Text controls in the report editor
- Text controls in the window editor
- Progress Bar controls
- Type of input mask
- Regular expressions in the input masks
- Spreadsheet control
- Limits
InputMask (Property) In french: MasqueSaisie
..InputMask is used to: - find out the input mask.
- modify the input mask (among the available masks for the type).
..InputMask applies to all controls used to type or display a text: ..InputMask also applies to the Calculated controls or to the Static controls found in the reports. Remark: The input mask of a control is defined in the window or report editor, in the "General" tab of the control description.
For more details on the different input masks available and their characteristics, see Input mask.  Versions 15 and later New in version 15Versions 18 and later New in version 18 Versions 20 and later New in version 20 Versions 21 and later New in version 21
// Modify the mask of "EDT_CustomerName"
EDT_CustomerName..InputMask = maskUpper
// Modify the mask of the 1st table row for the COL_Price column
TABLE_Table1.COL_Price[1]..InputMask = "9999,99"
// The mask is taken into account by the displayed value
Info(TABLE_Table1.COL_Price[1]..DisplayedValue)
Syntax
Finding out the input mask of a control Hide the details
<Result> = <Control used>.InputMask
<Result>: Constant or character string Input mask of specified control. The input mask depends on the type of control. See remarks for more details. <Control used>: Control name Name of control to use.
Modifying the input mask of a control Hide the details
<Control used>.InputMask = <New input mask>
Remarks Numeric controls (except for the currency controls) 1. Preset input masks | | | maskFileSize | Numeric mask for the file and disk sizes. | Versions 17 and latermaskSystemNumeral New in version 17maskSystemNumeral maskSystemNumeral | Numeric mask used by the system. Corresponds to the mask selected in the system regional settings ("Regional options" in the control panel). |
Example:
EDT_Edit1..InputMask = maskFileSize
EDT_Edit1 = 5681234 // Displays 5,68 MB
The change of unit (from KB to MB for example) is performed for each multiple of 1024. Therefore, the mask may display 1003 KB. 2. Custom input masks The input masks are defined via the following characters: "9", ".", ",", "+" and "-", "$" and space characters. For example: "99.999,99". In display mode, the decimal and thousand separators as well as the symbol defined for the language are taken into account. In programming (regardless of the language): - " " (space) is replaced by the thousand separator.
- "," (comma) is replaced by the decimal separator.
- "$" is replaced by the currency symbol (write "$$" to avoid this substitution).
3. Specific custom input masks - Using the % symbol:
Caution: Up to version 90028, the value assigned to the control by programming was displayed as it was, followed by the % character.
From version 90033, the valued assigned to the control by programming is multiplied by 100 and the "%" character is displayed. To restore the operating mode of the earlier versions, write "%%" to display the % character without multiplying the value by 100.
Example: - Assigning the control by programming:
EDT_Edit1..InputMask = "999,9%"
EDT_Edit1 = 0.562 // Displays 56,2 %
EDT_Edit1..InputMask = "999,9%%"
EDT_Edit1 = 0.562 // Displays 0,562 %
- Input in the control by the user:
- Mask 99.99%, value entered: 19.6, value displayed: 19,6%, valued handled by programming: 0,196.
- Mask 99.99%%, value entered: 19.6, value displayed: 19,6%, valued handled by programming: 19.6.
- Using brackets: displaying the negative numbers.
Example:
EDT_Edit1..InputMask = "(999 999)"
EDT_Edit1 = -1234 // Displays (1 234)
EDT_Edit1 = 1234 // Displays 1 234
- Using the - sign at the end of string: displaying negative numbers (ability to write "--" to display the - sign at the end of string).
Example:
EDT_Edit1..InputMask = "999 999 -"
EDT_Edit1 = -1234 // Displays 1 234-
- Multiple input mask: input mask used to define the format of positive numbers, the format of negative numbers, the value if 0 is used, the value if NULL is used. The following syntax is used:
<Format of positive numbers>;<Format of negative numbers>;<Value if 0>;<Value if NULL>
Example:
EDT_Edit1..InputMask = "999 999;-999 999;0;<NULL>"
EDT_Edit1 = -1234 // Displays - 1 234
Remark: You can specify a color using [<Color>] next to the desired mask. <Color> can correspond to:- one of the following constants: Red, Green, Blue, Black, White, Yellow, Orange.
- an hexadecimal value in "#BBGGRR" format.
Example:
EDT_Edit1..InputMask = "999 999;-999 999[Red];0;<NULL>"
EDT_Edit1 = -1234 // Displays - 1 234 in red
EDT_Edit1..InputMask = "999 999;-999 999[ #FF0000];0;<NULL>"
EDT_Edit1 = -1234 // Displays - 1 234 in blue
Remark: The color specified in the input mask has priority over ..Color. It is ignored if the control is grayed.
Remarks: - If you want the number to be filled with zeros on the left, use the "0" character on the left of the mask. For example: "099.999,99".
- If you want the decimal part of the number to be filled with zeros, use the character "9" on the right of the decimal point. For example, when using the "9999,99000" mask, the number 12 is displayed as "12,00" and not as "12,00000".
However, the number "12,368" is displayed properly: its value is preserved, without being truncated or rounded. - To force the signs, use the "+" character on the left. For example: "+9999".
Versions 18 and later  You also have the ability to specify hexadecimal input masks (between 0xF and 0xFFFFFFFFFFFFFFFFF). New in version 18 You also have the ability to specify hexadecimal input masks (between 0xF and 0xFFFFFFFFFFFFFFFFF). You also have the ability to specify hexadecimal input masks (between 0xF and 0xFFFFFFFFFFFFFFFFF).
Currency controls The input masks have the same type as the numeric masks. The difference is found in the precision: the currencies have 17 significant digits for the integer part and up to 6 digits for the decimal part. For example: "99 999 999 999 999 999,999999". Remark: A preset mask can also be used for the Currency controls:
| | Versions 17 and latermaskSystemCurrency New in version 17maskSystemCurrency maskSystemCurrency | Currency mask used by the system. Corresponds to the mask selected in the system regional settings ("Regional options" in the control panel). |
Currency + Euro controls The input masks have the same type as the currency masks. The dollar character ("$") can be added into the mask to display the current currency. For example: "999,99 $" will display "250,25 F" if the current currency is the French Franc. Date controls The input masks for the Date controls are: - "DD/MM/YYYY"
- "DD/MM/YY"
Versions 16 and later"DDD DD" New in version 16"DDD DD" "DDD DD"- "MM/DD/YYYY"
- "MM/DD/YY"
- "YYYY/MM/DD"
- "YY/MM/DD"
- "DD/MM/YYYY HH:MM:SS"
- "MM/DD/YYYY HH:mm:SS"
- "DD/MM/YYYY HH:mm:SS:CCC"
- "MM/DD/YYYY HH:mm:SS:CCC"
- "DDDD DD MMMM YYYY"
Versions 16 and later"Dddd DD Mmmm YYYY" New in version 16"Dddd DD Mmmm YYYY" "Dddd DD Mmmm YYYY"Versions 16 and later"Dddd DD Mmm YYYY" New in version 16"Dddd DD Mmm YYYY" "Dddd DD Mmm YYYY"- DD (corresponding to the day of the week in digits, for example: 12)
- "DDDD" (corresponding day of the week, "Thursday" for example). The case used depends on the linguistic options of the project.
Versions 16 and later"Djjjj" (corresponding to the day of the week with the first forced letter in upper case, e.g.: Monday)  This notation is not available. New in version 16"Djjjj" (corresponding to the day of the week with the first forced letter in upper case, e.g.: Monday) This notation is not available. "Djjjj" (corresponding to the day of the week with the first forced letter in upper case, e.g.: Monday)
This notation is not available. Versions 16 and later"ddjjjj" (corresponding to the day of the week with the first forced lowercase letter, for example: monday) This notation is not available. New in version 16"ddjjjj" (corresponding to the day of the week with the first forced lowercase letter, for example: monday) This notation is not available. "ddjjjj" (corresponding to the day of the week with the first forced lowercase letter, for example: monday)
This notation is not available. - "DDD" (abbreviation for the day of the week, "Thu" for example). The case used depends on the linguistic options of the project.
Versions 16 and later"Ddjj" (abbreviation of the day of the week with the first forced letter in upper case, for example: mon) This notation is not available. New in version 16"Ddjj" (abbreviation of the day of the week with the first forced letter in upper case, for example: mon) This notation is not available. "Ddjj" (abbreviation of the day of the week with the first forced letter in upper case, for example: mon)
This notation is not available. Versions 16 and later"ddjj" (abbreviation of the day of the week with the first forced lowercase letter, for example: Mon) This notation is not available. New in version 16"ddjj" (abbreviation of the day of the week with the first forced lowercase letter, for example: Mon) This notation is not available. "ddjj" (abbreviation of the day of the week with the first forced lowercase letter, for example: Mon)
This notation is not available. - MM (month in digits, for example: 12)
- "MMMM" (month spelled out, "January" for example). The case used depends on the linguistic options of the project.
Versions 16 and later"Mmmm" (month in words with the first forced capital letter, for example: January) This notation is not available. New in version 16"Mmmm" (month in words with the first forced capital letter, for example: January) This notation is not available. "Mmmm" (month in words with the first forced capital letter, for example: January)
This notation is not available. Versions 16 and later"mmmm" (month in full with the first forced lowercase letter, for example: January) This notation is not available. New in version 16"mmmm" (month in full with the first forced lowercase letter, for example: January) This notation is not available. "mmmm" (month in full with the first forced lowercase letter, for example: January)
This notation is not available. - "MMM" (abbreviation of the month, "Jan" for example). The case used depends on the linguistic options of the project.
Versions 16 and later"Mmm" (abbreviation of the month with the first forced uppercase letter, for example: Jan) This notation is not available. New in version 16"Mmm" (abbreviation of the month with the first forced uppercase letter, for example: Jan) This notation is not available. "Mmm" (abbreviation of the month with the first forced uppercase letter, for example: Jan)
This notation is not available. Versions 16 and later"mmm" (abbreviation of the month with the first forced lowercase letter, for example: jan) This notation is not available. New in version 16"mmm" (abbreviation of the month with the first forced lowercase letter, for example: jan) This notation is not available. "mmm" (abbreviation of the month with the first forced lowercase letter, for example: jan)
This notation is not available. - "YYYY" (year on four digits, "2001" for example)
- "YY" (last two digits of the year, "01" for example)
- the date defined by the project.
The date defined by the project depends on the date format selected in the parameters of the project language: - on the "Project" pane, in the "Project" group, click "Description".
- display the "Languages" tab then the linguistic options regarding the date.
These masks can be combined. For example: "Ddd DD Mmmm YYYY at HH:mm" will return a result in the following format: "Thu 01 February 1979 at 21:35". Time controls The input masks for the time controls are: - "HH:MM".
- "HH h MM".
- "HH:MM:SS".
- "HH:MM:SS AM": Used to manage the time in AM/PM format.
- "HH:MM:SS:CC".
- The preset mask corresponds to the system time. The system time depends on the mask selected in the regional system setings ("Regional options" in the control panel).
| | Versions 17 and latermaskSystemTime New in version 17maskSystemTime maskSystemTime | Mask used by the system for the time. |
DateTime controls To specify a DateTime input mask, you must: - Switch the type of the control (or table column) to Date ("Details" tab in the description window of the control or column).
- Modify the input mask of this control or column ("Details" tab of the description window of the control or column, or ..InputMask).
Duration controls The following elements can be used to define a custom mask (case sensitive). To present the custom masks, let's take a duration equal to 0 day 04 hours 15 minutes 03 seconds and 412 thousandths of a second: - +1: only the most significant unit will be displayed (the number of hours in our example).
- +2: only the two most significant units will be displayed (the number of hours and the number of minutes in our example).
Specify '+3' or '+4' to display the three or four most significant units. - D: the number of days will be displayed if this number is greater than 0 (the number of days will not be displayed in our example).
- H: the number of hours will be displayed if this number (or if the number of days) is greater than 0. If this number contains a single digit, this digit will be displayed (the number of hours will be '4' in our example).
- HH: the number of hours will be displayed if this number (or if the number of days) is greater than 0. If this number contains a single digit, this digit will be preceded by '0' (the number of hours will be '04' in our example).
- M: the number of minutes will be displayed if this number (or the number of days, or the number of hours) is greater than 0. If this number contains a single digit, this digit will be displayed (the number of minutes will be '15' in our example).
- MM: the number of minutes will be displayed if this number (or the number of days, or the number of hours) is greater than 0. If this number contains a single digit, this digit will be preceded by '0' (the number of minutes will be '15' in our example).
- S: the number of seconds will be displayed if this number (or if the number of days, or the number of hours, or the number of minutes) is greater than 0. If this number contains a single digit, this digit will be displayed (the number of seconds will be '3' in our example).
- SS: the number of seconds will be displayed if this number (or if the number of days, or the number of hours, or the number of minutes) is greater than 0. If this number contains a single digit, this digit will be preceded by '0' (the number of seconds will be '03' in our example).
- CC: the number of hundredths of second will be displayed (the number of hundredths of second will be '41' in our example).
- CCC: the number of thousandths of second will be displayed (the number of thousandths of second will be '412' in our example).
Remark: If the separator corresponds to the ":" character, the letter corresponding to the most significant unit will be added ('h' for hour, 'm' for minute, 's' for second, 'cs' for hundredths of a second and 'ms' for thousands of a second). Type of input mask Caution: A mask can be replaced by a mask of the same type. For example, the input mask of a DATE control cannot be replaced by the input mask of a TIME control. Assigning an incorrect input mask will trigger an error message. Versions 20 and later New in version 20
Related Examples:
|
Unit examples (WINDEV): The regular expressions
[ + ] Using regular expressions with WINDEV. Two use modes are presented for the regular expressions: - checking the input format - checking out different elements while respecting the input format. This example is also used to search for a word in a string. The search can be case-sensitive or not. Possibility to take into account (or not) the start or end of string, as well as spaces (anywhere in the string, even in the sought word)
|
|
Unit examples (WINDEV): Advanced input mask
[ + ] Handling the input masks in WINDEV: - Defining the format of positive/negative number in a numeric edit control - Defining how negative numbers will be displayed in a numeric edit control - Defining how the value 0 will be displayed in a numeric edit control - Using a regular expression to prevent from typing characters other than 1, 2, 3, 4, 5 and 6. - Using a regular expression to "regulate" the input of a French registration number
|
|
|
Unit examples (WINDEV Mobile): The regular expressions
[ + ] Using regular expressions with WINDEV Mobile. It presents 2 modes for using the regular expressions: - check the input format - check out the different elements that match the input format. This example is also used to search for a word in a string. The search can be case-sensitive or not. Possibility to take into account (or not) the start or end of string, as well as spaces (anywhere in the string, even in the sought word)
|
This page is also available for…
|
|
|