Adaptable Forms

There are a few places in AdapTable where a custom form can be displayed, including:

• Custom Export Destinations
• Alert Messages
• Data Sets

AdapTable provides an Adaptable Form to make displaying form data easy.

Adaptable Forms are primarily made up of 3 collections:

• Title and Description
• Form Fields
• Adaptable Buttons

Adaptable Form Object

Adaptable Forms are defined using the AdaptableForm object, defined as folows:

Property	Description
buttons	Buttons to include in the Form
description	Additional information to appear in the Form
fields	Collection of Dynamic Fields to display
title	Title to appear in the Form

Title & Description

The form object has 2 string properties used to display information about the form:

• title - text shown at the top of the Form
• description - additional text showing information the form requires and displayed beneath the title

Fields

A Form can contain as many fields as required.

All fields are are of type AdaptableFormField which is defined as folows:

Property	Description
defaultValue	Field Default Value - can be of type string, boolean, number
fieldType	Field Type: text, date, number, checkbox, select, textOutput
label	Label to display in the Field
name	Name of the Field
options	Items to populate the 'select' fieldType

Field Types

The fieldType property describes which UI control to display for the field.

It is of type AdaptableFormFieldType and can be any of:

• text
• select
• date
• number
• checkbox
• textOutput

Buttons

Forms can additionally include Buttons to perform actions.

The Buttons are of type AdaptableButton described above.