Overview

An input grid is a control that allows the user to select and edit a range of items corresponding to a Table Named Range (TNR) from the spreadsheet model. An input grid column constitutes a single column of that input grid, which - in turn - refers to a single column of the corresponding Table Named Range (TNR).

Properties

The properties of an input grid column are outlined below.

Title

Sets the header label for the column in the input grid.

Tooltip

Sets the tooltip text value that displays in a bubble when the end-user hovers over the column header.

Support Sorting

Defines whether or not the column supports sorting. If sorting is allowed for the column, an additional property - Sort Type - will become visible.

Sort Type defines the type of sorting that will apply to the values in that column. This includes Default, Numeric, DateTime, and Natural sorting options.

Default sorting is a standard character-based sorting operation.
Numeric sorting is a numeric value-based sorting operation.
DateTime sorting is a date-based sorting operation
Natural sorting is a chunk-based alphanumeric sorting operation, in which alphabetical and numeric chunks are split out of the string value and compared individually until a greater-than or less-than comparison can be performed. For example, natural sorting will produce ["1 Main St", "2 Main St", "11 Main St"] whereas default sorting will produce ["1 Main St", "11 Main St", "2 Main St"].

Support Search

Support Search allows you to define whether or not the column is searchable. If any single column is searchable, the input grid will be rendered with a search box in the upper-right corner. This allows the end user to filter down the grid to applicable rows based on a search operation that takes into account the sortable columns.

Mask Type

The Mask Type determines the format of the column values, as well as the acceptable values that can be entered into an editable columns.

This option is available only when the input grid has the Use Metadata Formatting feature disabled.

The following mask types are valid:

None - Freeform string entry is accepted, irrespective of numeric or alphabetical entry.
Boolean - A checkbox will be rendered in each cell within the column, corresponding to a TRUE or FALSE value in the workbook cell.
Decimal - Only numeric values, including decimals, constitute valid user data entry in this column.
Percentage - Only numeric values, including decimals, constitute valid user data entry in this column. The values will be presented with a percentage mask. The underlying values will be decimals (e.g. 50 % => 0.50).
Currency ($) - Only numeric values, including decimals, constitute valid user data entry in this column. The values will be presented with a currency mask (i.e. $#,##0.00). This is the mask to use for USD ($) format.
Currency (€) - Only numeric values, including decimals, constitute valid user data entry in this column. The values will be presented with a currency mask (i.e. €#,##0.00). This is the mask to use for EUR (€) format
Currency (€) - Only numeric values, including decimals, constitute valid user data entry in this column. The values will be presented with a currency mask (i.e. £#,##0.00). This is the mask to use for GBP (£) format
Time - Only valid time values can be entered in this column.
US Date - Only valid date values can be entered in this column. Selecting a cell from this column will pop up a datepicker control where the user can select a date from a calendar. This is oriented towards United States users, where the common date format include the month first, followed by the day (MM/DD).
EU Date - Only valid date values can be entered in this column. Selecting a cell from this column will pop up a datepicker control where the user can select a date from a calendar.This is oriented towards global users, where the common date format include the day first, followed by the month (DD/MM).
List - This special mask is no longer available in Mask Type dropdown. Instead there is a new option Include Dropdown described below.
Telephone - For phone number inputs. The default phone number mask is "+111 (1111) 111111 1111111". You can navigate to the next number bracket using the space key.

Include Dropdown

This option designates that entry in cells from this column must be selected from values within a list. Selecting this mask will show a List Named Range dropdown in the page, where you must designate a corresponding List Named Range (LNR) from the workbook. When the user selects a cell from this column, values from the corresponding List Named Range (LNR) will be visible for selection.

Show Formatted List Options

This option is available only when When Include Dropdown is selected. When enabled, this feature displays the formatted value of the list options in the dropdown, as they would be displayed in Excel.

The value that is submitted for calculations is still the underlying, non-formatted value.

Enable Row Visibility By Value

This option allows showing or hiding a row based on the outcome of a Boolean field. Mask Type must be set to Boolean for this option to be available.

When enabled, this option only shows a row based on the value of the selected Boolean field. A True value indicates that the row is visible, while False hides the row.

If more than one column has this option enabled, the corresponding row will be visible if at least one such column has value True in the row.

Enable Row Editability By Value

This option allows disabling a row based on the outcome of a Boolean field. Mask Type must be set to Boolean for this option to be available.

When enabled, this option disables a row based on the value of the selected Boolean field. A True value indicates that the row is enabled and editable, while False disables the row and prevents the row from being edited. If the grid is Form-Based, then this will also prevent the row from being removed.

If more than one column has this option enabled, the corresponding row will be disabled if at least one such column has value False in the row.

Minimum Length

The minimum number of characters that can be entered into the input grid's cell for validation purposes.

This option is available only when the input grid has the Use Metadata Formatting feature disabled and is only relevant for those column's types that allow for free-form text entry (i.e. where the Mask Type is set to None or Email).

Maximum Length

The maximum number of characters that can be entered into the input grid's cell for validation purposes.

Minimum Value

The minimum value that can be entered into the input grid's cell for validation purposes.

This option is available only when the input grid has the Use Metadata Formatting feature disabled and is only relevant for numeric column's types (i.e. where the Mask Type is set to Decimal, Integer, Percentage or Currency).

Maximum Value

The maximum value that can be entered into the input grid's cell for validation purposes.

Minimum Date Value

The minimum date value that can be entered into the input grid's cell for validation purposes.

This option is available only when the input grid has the Use Metadata Formatting feature disabled and is only relevant for date column's types (i.e. where the Mask Type is set to US Date or EU Date).

Maximum Date Value

The maximum date value that can be entered into the input grid's cell for validation purposes.

Precision

The precision constitutes the number of values post-decimal for numeric fields that support decimal input.

Is Editable

Indicates whether or not this column is editable by the user; if not, then the user is not permitted to enter values into the column. Since input grids support columns containing both formula-based cells and input cells, it is strongly suggested that you make formula-based (or output) cells non-editable.

Visible in the Grid

Indicates whether the column is going to be visible.

Inline Grids

Inline Grids setting can be configured as Always or Never to indicate whether the column is to be permanently visible or hidden.

Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the visibility of the column can be configured to reflect the value of that named range using the By Value Of setting.

Form Based grids

Form Based Grids can be configured as Yes or No to indicate whether the column is to be made permanently visible or hidden.

Column Sizing Type

Determines how the column is to be partitioned in the input grid. You can select from 3 options to determine column width.

Auto

Setting the Column Sizing Type to Auto will make the system automatically set the column width based on the input properties and other columns present.

Pixel

Selecting Pixel for the Column Sizing Type will create a new option called Column Sizing Value. You can enter the desired number of pixels into the Column Sizing Value field to resize the column. For example, entering 100 will make this column take up 100 pixels in the input grid.

Percentage

Selecting Percentage for the Column Sizing Type will create a new option called Column Sizing Type. You can enter the desired ratio (0-100%) into the Column Sizing Value field to resize the column. For example, entering 20 will make this column take up 20% of the entire input grid.

Visible on the Form

Please note that this field is only available for the Form Based and Form Based Start Empty grids. This setting can be configured as Always or Never to determine whether the column is to be made visible or hidden on the modal input form, when adding a New row or Editing an existing one.

Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the visibility of the field on a modal input form can be configured to reflect the value of that named range using the By Value Of setting.

Required

Please note that this field is only available for the Form Based and Form Based Start Empty grids. However, the Is Editable option also must be enabled to activate this setting. This option can be configured as Always or Never to determine whether the column value is required on the modal input form when adding a New row or Editing an existing one.

By Value Of Column option allows configuring whether the column is to be made required based on the value of another column in the same row.

Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the required-ness of the field on a modal input form can be configured to reflect the value of that named range using the By Value Of setting.

Input Grid Column

Table of Contents