projects/components/widgets/input/default/src/text/text.component.doc.ts
The wmText component defines the text widget.
Methods |
Inputs |
onBlur | ||||||||||||
onBlur($event: Event, widget: any)
|
||||||||||||
Callback function which will be triggered when the widget loses focus.
Parameters :
Returns :
void
|
onChange | ||||||||||||||||||||
onChange($event: Event, widget: any, newVal: string | number, oldVal: string | number)
|
||||||||||||||||||||
Callback function which will be triggered when the widget is clicked or when datavalue has changed.
Parameters :
Returns :
void
|
onClick | ||||||||||||
onClick($event: MouseEvent, widget: any)
|
||||||||||||
Callback function which will be triggered when the widget is clicked.
Parameters :
Returns :
void
|
onFocus | ||||||||||||
onFocus($event: Event, widget: any)
|
||||||||||||
Callback function which will be triggered when the widget gets focused.
Parameters :
Returns :
void
|
onKeydown | ||||||||||||
onKeydown($event: KeyboardEvent, widget: any)
|
||||||||||||
Callback function which will be triggered whenever a key is pressed down.
Parameters :
Returns :
void
|
onKeypress | ||||||||||||
onKeypress($event: KeyboardEvent, widget: any)
|
||||||||||||
Callback function which will be triggered whenever a key is pressed.
Parameters :
Returns :
void
|
onKeyup | ||||||||||||
onKeyup($event: KeyboardEvent, widget: any)
|
||||||||||||
Callback function which will be triggered whenever a key is released.
Parameters :
Returns :
void
This method does not return anything |
onMouseenter | ||||||||||||
onMouseenter($event: MouseEvent, widget: any)
|
||||||||||||
Callback function which will be triggered when the mouse enters the widget.
Parameters :
Returns :
void
|
onMouseleave | ||||||||||||
onMouseleave($event: MouseEvent, widget: any)
|
||||||||||||
Callback function which will be triggered when the mouse leaves the widget.
Parameters :
Returns :
void
|
onTap | ||||||||||||
onTap($event: TouchEvent, widget: any)
|
||||||||||||
Callback function which will be triggered when the tap event is triggered on a widget.
Parameters :
Returns :
void
|
autocomplete |
Type : boolean
|
Default value : false
|
Enabling this property turns on auto-completion in the editor. |
autofocus |
Type : boolean
|
Default value : false
|
This property makes the element get focused automatically when the page loads. |
class |
Type : string
|
Class of the widget. |
conditionalclass |
Type : string
|
This property allows user to bind expression to class property. Bindable: |
conditionalstyle |
Type : string
|
This property allows user to bind expression to style property Bindable: |
datavalue |
Type : string
|
This is the default value to display value for an editor widget. Note that the display value is just what the user sees initially, and is not always the dataValue returned by the widget. Bindable: |
disabled |
Type : boolean
|
This property will be used to disable/enable the text widget on the web page. Bindable: |
displayformat |
Type : string
|
This property sets the format for the values displayed in the widget. Bindable: |
hint |
Type : string
|
Hint text is shown for the text widget on hover. Bindable: |
maxchars |
Type : number
|
Defines the maximum number of characters that can be entered in the editor. Bindable: |
maxvalue |
Type : number
|
Bind or enter a maximum value to the text when the type is set to numeric. Bindable: |
minvalue |
Type : number
|
Bind or enter a minimum value to the text when the type is set to numeric. Bindable: |
name |
Type : string
|
Name of the text widget. |
placeholder |
Type : string
|
Default value : 'Enter text'
|
A placeholder is text to show in the editor when there is no value. Bindable: |
readonly |
Type : boolean
|
Default value : false
|
Selecting this property prevents the user from being able to change the data value of a widget. Bindable: |
regexp |
Type : string
|
Default value : '.*'
|
Enter any regular expression to be used for client-side input validation. |
required |
Type : boolean
|
Default value : false
|
This property will be used to validate the state of the text widget when used inside a form widget. Bindable: |
shortcutkey |
Type : string
|
The shortcut key property specifies a shortcut key to activate/focus an element. |
show |
Type : boolean
|
Default value : true
|
This property will be used to show/hide the text widget on the web page. Bindable: |
step |
Type : number
|
Use the stepper to increment/decrement the input value by the specified step interval, when the type is set to numeric. |
tabindex |
Type : number
|
Default value : 0
|
This property specifies the tab order of the text Widget. |
type |
Type : string
|
Default value : 'text'
|
Type of the text widget. Allowed Values: |
updatedelay |
Type : number
|
Default value : 0
|
The amount of delay in milliseconds to update the datavalue. Bindable: |
updateon |
Type : string
|
Default value : 'blur'
|
Updates the datavalue as selected. Allowed Values:
|