XForms Manual
  • XForms
  • Form Template
  • Form Controls
    • General
    • Date Control (dat)
    • Expression (exp)
    • Images Control (img)
    • Lookup (lkp)
    • Multi-Choice (mch)
    • Number (num)
    • Signature Control (sig)
    • Table Control (tbl)
    • Text Control (txt)
    • Time Control (tim)
  • PDF Template
  • Reference Lists
  • Webhooks
Powered by GitBook
On this page
  • Settings
  • Column
  • Data (Rows)
  • Notes:
  • Column's requiredWhen
  • Row's hideWhen
  1. Form Controls

Table Control (tbl)

Settings

Setting

Value

​Comment

type

tbl

id

string (optional)

allows access to this control

append

true/false (optional)

true: Allows to add new rows to the table (default: false)

columns

array of Columns

(see below)

data

array of table Data (optional)

predefined table rows (see below)

blankRowCount

number (optional)

number of blank rows when printing blank form (default 2)

appendText

string (optional)

the title of button to add new row to the table. Default "Add new row".

footer

true/false (optional)

if true, the footer is displayed

Column

Attribute

Value

Comment

header

string

header text

id

string (optional)

used for accessing column value in expressions (below)

also used to access footer value when accessed outside of the table

name

string (optional)

footer value name when export form data

type

column type

valid types: txt,num,chk,mch,dat,tim,sig,lnk

locked

true/false (optional)

true: column cannot be edited, except for appended rows

default

(optional)

the default value of the column in appended rows

options

string (optional)

list of options for for multi-choice (mch) columns.

required

true/false (optional)

makes the column value required

requiredWhen

string (optional)

makes the column value required when certain value is entered in another column. See the notes section below for details.

format

string (optional)

for Date column similar to date control

for Time column similar to time control

for numeric column - "$" for currency - "%" for percentage

for Text column:

- "lower" for lowercase

- "upper" for uppercase

- "title" for title-case (capitalize first letter of each word)

maxLen

number (optional)

maximum number of character for Text Column

width

number (optional)

% width of the column compare to whole table width

footer

string (optional)

A string value to display in footer row for the column.

It also could be an aggregation function:

"=sum" to show sum of column values in all rows

"=avg" to show average of column values in all rows

"=count" to show count of rows

expression

string (optional)

mathematical expression that uses columns' "name" to generate calculated value. Example: "{fee}*{qty}*0.15" in which "fee" and "qty" are names of two columns in same table.

noDefault

true/false (optional)

For Time and Date column in new rows: if true, no default value will be set If false, the current date or time will be display in the column

(if not provided, default values will be displayed)

link

string (optional)

links the column to another column of "lookup" or "multi-choice" type.

format: "<column-id>:<value-name>". ex: "customer:name"

docType

string (optional)

Entity type (for Lookup Control)

lookupItem

string (optional)

Lookup items search box title (for Lookup Control)

lookupField

string (optional)

Lookup items field to display in table column (for Lookup Control)

showTimeZone

true/false (optional) default: false

if true, a time zone name will be displayed next to date and time. example: 05:22 PM (EDT)

Data (Rows)

values

array of values in order (optional)

predefined rows

locked

true/false (optional)

true: cannot delete the row

hideWhen

expression with true/false

the table row is hidden if expression is true (see below for details)

Notes:

Column's requiredWhen

It's similar to Expressions with other field IDs in { }

Example: ""{changeofownership} == true'"

Row's hideWhen

Similar to Column's requiredWhen (above). If the expression results a True value, the row will not be shown.

PreviousSignature Control (sig)NextText Control (txt)

Last updated 8 months ago