TableGroupConfig

A JSON object of TableGroups you wish to configure. Each TableGroup can be independently configured. If a TableGroup is not defined then the default options take effect. At the moment this is only used for button visibility. It is currently supported on WEB and HANDHELD devices.

Option

Description

Default

ShowButtons

The ShowButtons key is a true or false flag that controls whether any button displays for each line of the TableGroup.

It takes precedence over the other available options.

True

All buttons will display unless specifically stated otherwise with the other options.

ShowAdd

The ShowAdd key is a true or false flag that controls whether the Add Line button displays for each line of the TableGroup.

This option will have no effect if ShowButtons is set to false.

True

ShowDelete

The ShowDelete key is a true or false flag that controls whether the Delete Line button displays for each line of the TableGroup.

This option will have no effect if ShowButtons is set to false.

True

CustomButtons

The CustomButtons key is a JSON array of JSON objects where each object in the array is a definition for a new custom button. These definitions have 3 mandatory components;

  • Name - the text displayed on the button.

  • Type - the colour that is used for each button. These are based on Bootstrap 3 colours and are case insensitive. Options are:

    Default (White)

    Primary (Blue)

    Success (Green)

    Info (Light Blue)

    Warning (Yellow)

    Danger (Red)

  • Key - the value set is sent as a parameter called SubmissionKey. This is mainly used for sub-routines or commands.

They are very similar to how the `ButtonConfig` works, without the defaults. When a custom button is clicked, only that row's inputs will be sent, both in the TableGroup-XXX array and at the header level. The SubmissionKey will also be set to the buttons Key. Any other table groups that display on the page will be an empty array.

 
Example

JSON code

Copy 
{
  "TableGroupConfig": {
    "PCK1s": {
      "ShowButtons": true,
      "ShowAdd": true,
      "ShowDelete": false,
      "CustomButtons": [
        {
          "Name": "Update Item",
          "Type": "Primary",
          "Key": "Update"
        },
        {
          "Name": "Cancel Item",
          "Type": "Danger",
          "Key": "Cancel"
        }
      ]
    }
  }
}