Service Studio 5.1 Help
Input Widget Runtime Properties
When you use a Input widget in your web screens or web blocks, the following runtime properties (A property that you only can access at run-time. Runtime properties can be Read/Write or Read only.) are available:
Id: Identifies the widget in the HTML of the web screen or web block.
You can use this runtime property when, for example, developing your JavaScript.
Read only. Text type.
TypedValue: Holds the data the end user typed in the form.
You can use this runtime property to handle inputs validation when TypedValue cannot be converted to the variable's data type. For example, you could assign to Customer_Birth_Date.ValidationMessage the expression Customer_Birth_Date.TypedValue + " is not a valid date!"
Read only. Text type.
During rendering, if the TypedValue is incompatible with the variable data type and the widget's variable is not null, the TypedValue is used to display the widget's input, so all the values the end-user typed may be preserved.
When the TypedValue
is incompatible with the variable data type, the variable is set to the
widget's null value and the typed value is stored in the Input widget
runtime property.
If the Input widget is used inside a Table Records or a List Records, the TypedValue runtime property is always set to an empty string.
Valid: Indicates whether TypedValue is valid for the data type and optionality specified for the widget.
This property is set automatically by the platform when submitting the widget with a Button or Link whose Method property is set to Navigate. See Validate End-User Typed Values.
You can manually override this property, setting it to True or False with explicit logic, in a screen action. This allows you to perform further validations, more business oriented, in the server.
Read / Write. Boolean type.
When an input is invalid,
that is, when this property is false, it is rendered with the special
class Not_Valid.
Learn more about this in how widgets
are translated into HTML tags.
ValidationMessage: Text message automatically set by the platform when submitting the widget with a Button or Link whose Method property is set to Submit or Ajax. This runtime property is empty, when the Valid runtime property is True; or, when the typed value is invalid, has the default Validation Message that applies to the validation rule that failed.
You can manually override this property with explicit logic, in a screen action. This, along with the Valid property, allows you to perform further validations, more business oriented, in the server.
Read / Write. Text type.
The ValidationMessage
is rendered in HTML as a <span class="ValidationMessage">
element following the HTML <input>
element. See how widgets are translated
into HTML tags. You can change the layout of the validation messages
customizing the ValidationMessage style
in the style sheet.
Widget runtime
properties are only available in the scope of the web screen or web block
if the widget property Name is not empty.
See Also
About Runtime Properties | About Web Input Widget | Web Input Widget Properties | Web Widgets and HTML Tags