FreeText Column

The FreeText Column Module enables the creation of 'special columns' for users to save comments and other data that will not be persisted with the grid's data source, but in Adaptable State instead.

FreeText columns are similar to Calculated Columns in that they are not part of AG Grid's Column Definitions but are defined by Users and stored in Adaptable State for that user, and recreated each time the Application starts.

note

The difference with Calculated Column is that a FreeText Column is designed to be editable (not derived) - the purpose is for users to store whatever bespoke data they want for each row.

Column DataType

FreeText Columns have a DataType property which defines what type of data the column can store.

There are 4 possible values, each of which will result in a different cell editor:

  • String (the default value) - shows a text editor
  • Number - displays a numeric editor
  • Boolean - displays a checkbox
  • Date - displays a date picker
tip

If no value is set then the default of 'string' is used

When editing in the FreeText Column, AdapTable will automatically display an appropriate for its DataType (e.g. a date picker for 'Date').

note

If the DataType is string, there is an extra choice that can be made: TextEditor lets you pick between 'Inline' (the default) or 'Large' (useful if wanting to provide large quantities of text).

Stored Values

The FreeText Column stores any values which have been provided in the FreeTextStoredValues property.

The FreeTextStoredValue object is straightforward, allowing users to store values by primary key:

PropertyDescription
FreeTextValue to store in the cell
PrimaryKeyPrimary Key Column value for the row
tip

This can be set at Design Time so that a FreeText Column can be 'pre-populated' with relevant values

Default Value

FreeText Columns have an optional default value; if provided, the cell will display that value unless explicitly overriden by the User.

UI Elements

FreeText Column includes the following UI Elements:

  • Popup - Shows a list of existing FreeText Columns with Edit and Delete buttons. Plus an Add button to start the FreeText Column Wizard which facilitates the creation and editing of Free Text Columns. Each row in the popup is fully editable.

  • Column Menu - Existing FreeText columns have a Edit Free Text Column Menu Item which opens the Format Column wizard for that Column.

Entitlements

FreeText Column Entitlement Rules:

  • Full: Everything is available to the User

  • Hidden: Everything is hidden from the User

  • ReadOnly: N/A

FAQ

Where is the data stored for Free Text Columns?

With the User's Adaptable State wherever that is stored. Free Text Column data is not stored with the dataset of the underlying grid.

More Information