An OptionType backed by a free text input, rendered as an HTML text field. Used to declare a free text field for mail merge or field definitions, such as the configuration options for an email trigger, with the given placeholder shown in the editor.

Implements: OptionType


Properties

PropertyReturnsDescription
optionTypeIdStringThe option type identifier used by editors to pick the right input control for this type.
placeHolderTextStringThe placeholder text shown in the input when it is empty.

Methods

getPlaceHolderText()

Returns: String

The placeholder text shown in the input when it is empty.

getOptionTypeId()

Returns: String

The option type identifier used by editors to pick the right input control for this type.

toHtml(String triggerCode, String value)

Returns: String

Renders this option type as an HTML text input, HTML-encoding the given value for the value attribute.

ParameterDescription
triggerCodeused as the id and name attribute of the generated input element
valuethe current value of the field, HTML-encoded before being written to the value attribute
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.