Text Data

Description

Allows editing of free text data. Try it out here!


Parameters

NameRequiredAvailable InMigratable to Cloud?Default ValueDescription
Field Name
 Yes
Server, Data Center
No
The name of the text data field. Must be unique.
Type
 Optional
Server, Data Center
No
  • area - if macro is created with Rich Text Editor
  • line - if macro is created with wiki markup

The type of field. Applies to plain text content only. May be one of the following:

  • area - A multi-line text area field
  • line - A single-line text area field
  • password - A single-line password field

Note: Only applicable for forms mode.

Content Type
 Optional
Server, Data Center
No
  • richtext - if macro is created with Rich Text Editor
  • wiki - if macro is created with wiki markup

The type of content in the field. May be one of the following:

  • richtext
  • text
  • noformat
  • quote
  • code
  • wiki

Note: To input field within text-data of richtext or quote type, click on the field to initiate a richtext editor. Only applicable for forms mode.

Required
 Optional
Server, Data Center
No
false
If true the field cannot be empty. 
Language
 Optional
Server, Data Center
No

The programming language to use for formatting the content Java or XML. This is only used when the Content Type is set to code.

e.g.: "content=code:JavaScript"

Whatever languages are valid for the {code} macro can be used.

Hide Full Text
 Optional
Server, Data Center
No
false

Clip text and display a "Show more" button if the text is more than one line. (Version 5.2.0 and above only.)


Minimum Length
 Optional
Server, Data Center
No
If specified, the text must be at least this many characters long.
Maximum Length
 Optional
Server, Data Center
No
If specified, the text must be at most this many characters long.
Pattern
 Optional
Server, Data Center
No

Specify the text that the content in the Text Data macro must match.

You may use regular expressions with this parameter. Consult this Knowledge Base article on the use of regular expressions with Scaffolding.

Pattern Error Message
 Optional
Server, Data Center
No

If the Pattern parameter is specified, this is displayed if the saved value does not match when the user clicks Save.

Width
 Optional
Server, Data Center
No

The width of the text field. e.g. "250px" or "100%".

Only applicable for forms mode.

Height
 Optional
Server, Data Center
No

The height of the text field. e.g. "250px" or "100%".

Only applicable for forms mode.


Editor View

Tutorial Examples