(Showing Draft Content)

InputMask Overview

The InputMask control allows you to validate and format user input as it is entered. The control prevents users from accidentally entering invalid data and saves time by skipping over literals (such as slashes in dates) as the user types.

The mask used to validate the input is defined by the mask property, which may contain one or more of the following special characters:

Character Mask Type
0 Digit.
9 Digit or space.
# Digit, sign, or space.
L Letter
l Letter or space.
A Alphanumeric.
a Alphanumeric or space.
. Localized decimal point.
, Localized thousand separator.
: Localized time separator.
/ Localized date separator.
$ Localized currency symbol.
< Converts characters that follow to lowercase.
> Converts characters that follow to uppercase.
Disables case conversion.
\ Escapes any character, turning it into a literal.
9 DBCS Digit.
J DBCS Hiragana.
G DBCS big Hiragana.
K DBCS Katakana.
N DBCS big Katakana.
K SBCS Katakana.
N SBCS big Katakana.
Z Any DBCS character.
H Any SBCS character.
All others Literals.

The main properties of the control include:

  1. value: It returns the full text content of the control, including the user's input and any template characters.
  2. rawValue: In contrast to value property, you can use the rawValue property to get or set the control value including only the input characters and excluding any template characters.
  3. promptChar: By default, the InputMask control uses an underscore character to indicate positions where input is expected. You can change this by assigning a new string to the promptChar property. Refer to the Prompt Character demo for examples.
  4. maskFull: It indicates whether the mask has been completely filled. Refer to InputMask Validation demo for an example .


  <input id="thePhone"><br>
import * as input from '@mescius/wijmo.input';

function init() {
    let thePhone = new input.InputMask('#thePhone', {
        mask: '(999) 000-0000'