Text
Text value
The list of common settings for parameters is available here.
Specification
multiline
Type:
Boolean
Default:
False
If
true
, the user will be able to insert new lines in GUI (atextarea
will be displayed instead of the text field).
tags
Type:
String
Specifies how to treat HTML tags.
Allowed values:
Key | Specification |
---|---|
strip | Removes HTML tags. |
stripall | Removes all HTML tags (including unclosed). |
escape | Converts |
validate
Type:
Object
Specifies parameter validation.
Available parameters:
Parameter | Type | Specification |
---|---|---|
max | number | Specifies maximum length. |
min | number | Specifies minimum length. |
pattern | string | Specifies a RegExp pattern that a text parameter should conform to. Note: In most cases, the pattern has to be wrapped in |
nested
Available types:
Type Specification array
Provides an array of nested parameters which are shown when the value of the parameter is set (value is not empty)
string
Provides URL address of an RPC to load list of nested parameters.
object
Provides a detailed specification of nested parameters.
Usage of nested fields:
Examples
Basic Text Field
A basic text input.
HTML Tags Stripping
You can enable HTML tags stripping or escaping using the tags
option.
Validating Length
By setting validate.max
and validate.min
you can control the length of the inserted string value.
Validating Pattern
You can use a RegExp to validate the text input.
Multiline Textarea (deprecated)
To allow entering multiline texts, set multiline
to true
.
Search Button
You can add an RPC button (also called as a search button), to perform an RPC call inside the field. Usually used to find an ID of a specific item.
You can read about it here or click below to read about the select parameter vs search button.
pageDynamic Fields RPCLast updated