Input Widget

The IQNOX Input widget is a heavily optimized replacement for the Text Box, Numeric Entry and Text Area widget.

Examples

Properties

Property	Type	Binding	Default value
Label	STRING(localized)	<		The text that is displayed above the input/textarea.
SecondaryLabel	STRING(localized)	<		Type of the input that will be passed to the widget.
InputType1	SELECT		Text	Options: Text, Text Area, Number, Email, Password, Search, Telephone Password.
Value	depending on InputType	<>		The value that will be entered in the widget.
Placeholder	STRING(localized)	<		Specifies a hint that describes the expected value of an input field.
ReadOnly	BOOLEAN	<	FALSE	Enables/Disables the textbox, making it read only.
Invalid	BOOLEAN	<>	FALSE	Shows invalid style with a warning icon at the end of the input.
InvalidTooltipMessage	STRING(localized)	<		Shows this message when hovering over the input while it's invalid. Use this to describe why the input is invalid.
TabSequence	INTEGER		0	Specifies the tab order of an element (when the "tab" button is used for navigating).
TriggerValueChangedImmediately	BOOLEAN		TRUE	If enabled, the ValueChanged event will be triggered after the last key was pressed based on the DebounceTime.
DebounceTime2	INTEGER		300	Time in milliseconds from last key pressed to triggering the ValueChanged event.
CustomClass	STRING	<>		Enables you to define an HTML class to the top div of the widget. Multiple classes can be separated by a space.
Pattern3	STRING			Specifies a regular expression that the value should match. If the value does not match, the input will become invalid. Specify a tooltip message to describe why the input is invalid.
ShowSecondaryLabel	BOOLEAN	<		Flag property which decides whether or not to show the Secondary Label.
Template	LIST		Template 1	The widget template to use for this widget
ShowHelpIcon	BOOLEAN	<	FALSE	Will enable a customizable icon on the right of the label, the icon will show the tooltip on hover for more documentation
HelpIcon	STRING	<		Icon to be displayed on the right of the label when ShowHelpIcon is enabled.
Tooltip	STRING(localized)	<		Optional tooltip used to display additional information. This tooltip can be styled globally from GlobalStyles. The InvalidTooltipMessage property is used when the input is invalid. see Tooltip
TooltipAnchor	STRING		Widget	If the tooltip should appear next to the Widget, or next to the cursor.
TooltipFormat	STRING(localized)	<		see Format Complex
TooltipType	LIST	<	Text	The widget tooltip type
TooltipMashup	MASHUPNAME	<		Mashup to be used as a tooltip when TooltipType is set as Mashup
TooltipWidth	NUMBER			Width of the tooltip. It won't be bigger than the Max-width set in the GlobalStyles for the Tooltip
TooltipHeight	NUMBER			Height of the tooltip. Can only be set if TooltipType is set as HTML, Markdown or Mashup
MinValue4	INTEGER	<		Minimum value of the number that this input can contain
MaxValue4	INTEGER	<		Maximum value of the number that this input can contain
Step4	INTEGER	<		Granularity of the numeric value entered in the input
PreventInvalidCharacters5	BOOLEAN		FALSE	Blocks the typing of invalid characters that do not match the rules defined by MinValue, MaxValue , Step or Pattern properties

Services

Property	Type	Binding	Description
ResetValue	SERVICE	<	Resets the Value of the widget to default
Blur	SERVICE	<	Removes the focus from the element
Focus	SERVICE	<	Forces the focus on the widget, allowing it to receive keyboard inputs

Events

Property	Type	Binding	Description
ValueChanged	EVENT	>	Triggers an event when the value of the widget is changed
EnterKeyPressed	EVENT	>	Triggered when the user presses the enter key

Footnotes

1. InputType Options:

   • Text
   • Text Area - doesn't have Type SELECT and is always Value STRING
   • Number
   • Password
   • Telephone
   • Email
   • Search
   ↩

2. DebounceTime is only available if TriggerValueChanged is TRUE, else ValueChanged is trigger on defocus/enter key pressed. ↩

3. Pattern is available only if the user selects from the InputType the following values: Password, Search, Email, Text, Telephone. ↩

4. MinValue, MaxValue properties are available only when the user selects the Number property from the InputType. ↩ ↩² ↩³

5. PreventInvalidCharacters: Depends on the values in Pattern, for string inputs, or MinValue, MaxValue and Step for numeric inputs. Blocks the typing of invalid characters. If the Step property is set to 0.01 and PreventInvalidCharacters is true, the input won't accept more than 2 decimals. ↩