Column Properties

This section describes the properties that you can set on a grid column.

Property Description
Field name

The field in the data source object from which / to which the column’s cells should be read/written.

You don’t need to associate a column with a field in the data source object. For example, you wouldn’t want to do this for an action button column.

Similarly, for a calculation column, you may want to store the result of the calculation to the data source object — but equally, you may want to display it to the agent but not store it.

Note: Be sure to select an appropriate field for the Column type. For example, a column with a Column type of Date time must be mapped to a datetime field in your data source object.

Sequence number Defines the order in which columns appear in the grid. You can use any numbers; the lowest number will be the first column in the grid and the highest number will be the last column.
Column title The title of the column.
Column type

The data type for cells in this column. You can select the following column types:

  • Action button: Shows an action button in the cell, which the agent can click to perform one or more actions. The text shown on the action button is the Column title.
  • Calculation: Shows the result of a calculation in the cell.
  • Check box: Shows a check box in the cell, which the agent can select or clear. Writes 0 or 1 to the database.
  • Date: Shows a date picker when the agent clicks the cell. The agent can also manually type a date. Note that if the agent types an invalid date, the field will default to today’s date.
  • Date time: Shows a date and time picker when the agent clicks the cell. The agent can also manually type a date and time. Note that if the agent types an invalid date, the field will default to today’s date at 00:00.
  • Image: Shows an image in the cell.
  • Money: Lets the agent enter an amount of money in the cell. This is prefixed with a currency symbol, such as £ or $ (as defined in the Config property).
  • Number: Lets the agent enter a number (only) in the cell, including decimals. Note that, upon saving to the data source object, numbers are truncated rather than rounded if they do not match the field’s format. For example, 4.9 would be saved as 4 (not 5) to a field that does not allow decimals.
  • Dropdown: Shows a dropdown in the cell.
  • Text box: Lets the agent enter text (a string) in the cell.
  • Multiline text box: Lets the agent enter text in a multiline cell.

Note: If you don’t select a column type, it defaults to text.

Config

Shows for the following column types:

  • Action button: Select the actions to perform when the agent clicks the action button.
  • Calculation: Using the Calculation Builder, write a calculation expression.
  • Image: Using the Calculation Builder, write an expression to define the URL source of the image. If the URL will always be the same, then the expression should just be the URL (between ' and '), for example 'https://www.example.com/myimage.png'.
  • Money: Type a currency character (such as $ or £) to show before the field’s value.
Width

Defines the width of the column in pixels.

Because a grid always take up the full width of the data entry element container in which it is placed, Syntelate XA will automatically adjust the value that you enter if necessary.

Default value Defines a default value for cells in this column, when the agent inserts a new row.
Sort grid by this column?

Sorts the grid by this column when the grid first loads.

Once loaded, the agent can choose to sort the grid by any other column for which the Sortable? property has been set.

Sort ascending? Where Sort grid by this column? has been set, defines whether the grid should initially be sorted in ascending order. Click No to sort in descending order.
Editable? Defines whether the agent can edit the cells in this column when adding a new row or editing an existing row, or where attempting to edit a separate data entry control that points to the grid field (see Controls Linked to a Grid).
Sortable? Set to No to prevent the agent from sorting by this column.
Visible?

Set to No to hide this column so that the agent cannot see it. You would want to do this if, for example, you intend to display the field, not in a grid control, but in another data entry control (see Controls Linked to a Grid).

Required? Set to Yes to prevent the agent from saving a new row or saving edits to an existing row when the cell in this column is blank.