Input (string)

Click to copy

Input field for string


Look and Feel Settings:

Label (not mandatory) - label for input.

Default value (not mandatory) - input default value.

Placeholder (not mandatory) - placeholder for input.

Name (mandatory) - name of the input.

Tooltip (not mandatory) - hint for input.

Required (mandatory) - makes the field mandatory. Disabled by default.

Allow clear (mandatory) - icon to clear the input. Disabled by default.

Validate icon (mandatory) - validate icon for input. Disabled by default.

Disabled (mandatory) - makes the component disabled if turned on. Is turned off by default.

Visible (mandatory) - makes the component visible if turned on. Enabled by default.

Input String


Workflow triggers:

  • onCreate – fires when the element is created on the page; 
  • onShow – fires when the component changes its state to visible (displayed on the page); 
  • onHide – fires when the component changes its state to hidden (stops being displayed);
  • onDestroy – fires before the component is destroyed; 
  • onChange - fires when the value is changed;
  • onFocus - fires when component is being focused;
  • onBlur - fires when component is blurred;
  • onEnterKey - fires when Enter is pressed.

Component Actions:

InputString Get Properties

Gets the component's properties.

Input parameters:

  • Component Id [string] - input component's identifier.

Output parameters:

  • Label [string] - input label;
  • Placeholder [string] - input placeholder;
  • Allow clear [boolean] - state of allow clear;
  • Disable [boolean] - disables component if true;
  • Visible [boolean] - component visibility state;
  • Tooltip [string] - input field hint;
  • Required [boolean] - shows required mark if true;
  • Debounce (ms) [integer] - delay to validate the value;
  • Value [string] - value from input;
  • Validate Icon [boolean] - icon to be shown on validate the value;
  • Validate Status [Status type] - status to be shown on validate the value; 
  • Validate Message [string] - message to be shown on validate the value.

Input String Get Properties

InputString Set Properties

Sets the component's properties.

Input parameters:

  • Component Id [string] - input component's identifier;
  • Label [string] - input label;
  • Placeholder [string] - input placeholder;
  • Allow clear [boolean] - state of allow clear;
  • Disable [boolean] - disables component if true;
  • Visible [boolean] - component visibility state;
  • Tooltip [string] - input field hint;
  • Required [boolean] - shows required mark if true;
  • Debounce (ms) [integer] - delay to validate the value; 
  • Value [string] - value from input;
  • Validate Icon [boolean] - icon to be shown on validate the value;
  • Validate Status [Status type] - status to be shown on validate the value; 
  • Validate Message [string] - message to be shown on validate the value.

Input String Set Properties

InputString Update Properties

Update the component's properties.

Input parameters:

  • Component Id [string] - input component's identifier;
  • Label [string] - input label;
  • Placeholder [string] - input placeholder;
  • Allow clear [boolean] - state of allow clear;
  • Disable [boolean] - disables component if true;
  • Visible [boolean] - component visibility state;
  • Tooltip [string] - input field hint;
  • Required [boolean] - shows required mark if true;
  • Debounce (ms) [integer] - delay to validate the value; 
  • Value [string] - value from input;
  • Validate Icon [boolean] - icon to be shown on validate the value;
  • Validate Status [Status type] - status to be shown on validate the value; 
  • Validate Message [string] - message to be shown on validate the value.

Input String Update Properties



Usage example

Most often, the InputString is used in forms for working with records in the database.

Example Input String