wijinputmask jQuery Widget

Create input boxes to collect information from your users securely with masking characters or with visual cues about the type of data to input.

Syntax

Javascript (Usage)
Javascript (Specification)

$(function () {
    var options; // Type:  wijmo.input.wijinputmask.options
     
    $(".selector").wijinputmask(options);
});

function wijinputmask() : any;

Options

	Name	Description
	allowPromptAsInput	Default value: false Indicates whether promptChar can be entered as valid data by the user.
	autoConvert	Default value: true Gets whether the control automatically converts to the proper format according to the format setting.
	blurOnLastChar	Default value: false Determines whether or not the next control in the tab order receives the focus as soon as the control is filled at the last character.
	blurOnLeftRightKey	Default value: 'none' Determines whether the focus automatically moves to the next or previous tab ordering control when pressing the left, right arrow keys. Possible values are "none", "left", "right", "both". The default value is "none".
	culture	Default value: "" Determines the culture used to show values in the wijinput widget.
	cultureCalendar	Default value: "" Assigns the string value of the culture calendar that appears on the calendar. This option must work with culture option.
	dropDownButtonAlign	Default value: 'right' Determines the side, left or right, where the dropdown button appear. Possible values are: 'left', 'right'
	hideEnter	Default value: false If true, then the browser response is disabled when the ENTER key is pressed.
	hidePromptOnLeave	Default value: false Indicates whether the prompt characters in the input mask are hidden when the input loses focus.
	highlightText	Default value: 'none' Determines whether to highlight the control's text on receiving input focus. Possible values are : "none", "field", "all"; The default value is "none";
	imeMode	Default value: 'auto' Determines the input method setting of widget. Possible values are: 'auto', 'active', 'inactive', 'disabled'
	invalidClass	The CSS class applied to the widget when an invalid value is entered.
	maskFormat	Default value: "" Determines the input mask to use at run time.
	passwordChar	Default value: "" Determines the character to be substituted for the actual input characters.
	pickers	Type: wijmo.input.PickerClass An object contains the settings for the dropdown list.
	placeholder	Determines the text displayed when the widget is blank and contains no initial text.
	promptChar	Default value: '_' Determines the character that appears when the widget has focus but no input has been entered.
	readonly	Default value: false Determines whether a user can enter a value in the wijinput widget. If readonly is true, user can't input value to the wijinput widget by ui operation, such as spin, pick value from pickers.
	resetOnPrompt	Default value: true Determines how an input character that matches the prompt character should be handled.
	resetOnSpace	Default value: true Determines how a space input character should be handled.
	showDropDownButton	Default value: false Determines whether dropdown button is displayed.
	skipLiterals	Default value: true Indicates whether the user is allowed to re-enter literal values.
	tabAction	Default value: 'control' Determines whether the focus will move to the next filed or the next control when press the tab key. Possible values are "control", "field".
	text	Default value: null Determines the default text.

Top

Methods

	Name	Description
	destroy	Destroy the widget.
	drop	Open the dropdown list.
	focus	Set the focus to the widget.
	getPostValue	Gets the text value when the container form is posted back to server.
	getSelectedText	Gets the selected text.
	getText	Gets the text displayed in the input box.
	isDestroyed	Get a boolean value indicates that whether the widget has been destroyed.
	isFocused	Determines whether the widget has the focus.
	selectText	Selects a range of text in the widget.
	setText	Sets the text displayed in the input box.
	widget	Gets element this widget is associated.

Top

Events

	Name	Description
	dropDownButtonMouseDown	The dropdownButtonMouseDown event handler. A function called when the mouse is pressed down on the dropdown button.
	dropDownButtonMouseUp	The dropdownButtonMouseUp event handler. A function called when the mouse is released on the dropdown button.
	dropDownClose	The dropdownClose event handler. A function called before the widget's dropdown closed.
	dropDownOpen	The dropdownOpen event handler. A function called before the widget's dropdown opened.
	initialized	The initialized event handler. A function called after the widget is initialized.
	initializing	The initializing event handler. A function called before the widget is initialized.
	invalidInput	The invalidInput event handler. A function called when invalid charactor is typed.
	keyExit	Fired when the widget lost focus and caused by the keyboard behavior.
	textChanged	Fired when the widget text is changed.

Top

Widgets

InputMask

Reference

wijinputmask jQuery Widget