Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

English
Text Field is a standard HTML Input element to collect information from the user in a form.

Get Started

The easiest way to see how the Text Field works is to use the existing built-in App Expenses Claims. Here are the steps:

...

  1. Start the Joget Server  and open the  App Center.

  2. Log in as  admin  and click on the pencil icon on the  Expenses Claim  to open the  Design App. (see Figure 1)

    Image Added
    Figure 1

  3. Click on

...

  1. Expense Claim New and you will be directed to the

...

  1. Form Builder. 

  2. Hover the mouse over the Title (Example: China Travel, July Claims, etc.) field and click on Edit to open up the Edit Text Field properties.

...



  1. Click on Preview and try entering values into the Text Field.

Image Removed

Figure 1

...


  1. Image Added
    Figure 2

Text Field Properties

Edit Text Field Properties

Image Added

NameDescriptionScreen (Click to view)
ID

Element ID (By declaring as "title", a corresponding database table column "c_title" will be created)

Please see Form Element for more information about defining the ID and list of reserved IDs.

Chinese

元素ID(通过声明为“title”,将创建相应的数据库表列“c_title”)

Image Removed

LabelElement Label to be displayed to the end-user.

Advanced Options

Data

Image Added

Image Removed
NameDescriptionScreen (Click to view)
Value

Default Value when there's no existing value found.

A hash variable is accepted here. For example, you may key the following

Chinese

没有找到现有值时的默认值。

这里接受哈希变量。例如,您可以键入以下内容

Code Block
#currentUser.firstName# #currentUser.lastName#

to pre-populate the field with currently logged in user's name.

Chinese

预先使用当前登录用户的名称填充字段

Max Length

Maximum character length allowed.

Validator

Attach a Validator plugin to validate the input value, more information at Form Validator.

Info
titleWhen will validation takes place?

Validation will take place whenever a form is submitted, except when it is submitted as "Save as Draft".

Encryption

Determines if the value should be encrypted upon saving into the database. Read more in Protect Sensitive Data.

Sanitize Input Value?

Checking the box will sanitize the input value before storing input data to database. Please see Form Input Sanitization

Workflow Variable

If the form is part of a workflow process, upon saving of the form (by clicking on "Save as Draft" or "Complete" button). The value in this input field will be saved into the corresponding workflow variable named here.

Info
titleUsing a non-existent Workflow Variable name

You will get the following warning with the name printed out (e.g. status) in the server log if you attempt to map to a non-existent Workflow Variable.

Code Block
context attribute status does not exist in process context - adding new attributes to the process context is not allowed


UI

Image Added

Image Removed

NameDescriptionScreen (Click to view)
Placeholder

The placeholder attribute specifies a short hint that describes the expected value of an input field (e.g. a sample value or a short description of the expected format). The short hint is displayed in the input field before the user enters a value.

Size

Width of the element.

Readonly

Determines if the element is editable.

Display field as Label when readonly?

Displays the value of the element as plain text when an element is set to "Readonly".

Workflow

Image Added

NameDescriptionScreen (Click to view)
Workflow Variable

If the form is part of a workflow process, upon saving of the form (by clicking on "Save as Draft" or "Complete" button). The value in this input field will be saved into the corresponding workflow variable named here.

Info
titleUsing a non-existent Workflow Variable name

You will get the following warning with the name printed out (e.g. status) in the server log if you attempt to map to a non-existent Workflow Variable.

Code Block
context attribute status does not exist in process context - adding new attributes to the process context is not allowed

Image Removed

Number Formatting

Image Added

Image Removed
NameDescriptionScreen (Click to view)
Formatting Style
  • US Style Formatting (1,000.00)
  • European Formatting (1.000,00)

When you have selected this option, you can further define the following attributes:-

  • Number of Decimal
  • Prefix
  • Postfix
  • Use Thousand Separator?
Store as Numeric Value?

When formatting is applied, value is stored as it is. You may check this option to strip off formatting and store it as numerical value only.


Related Tutorials: