Output Grid Column

  1. Help
  2. User Interface Designer
  3. Output Grid Column
outputgrid column input control

Table of Contents

Overview

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

Properties

The properties of an output grid column are outlined below.

Title

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

Tooltip

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

Content Alignment

Aligns the column contents Left, Right, or Center. Selecting None will omit alignment rules.

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 values that display in the column.

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

The following mask types are valid:

  • None - No formatting will be applied to the values displayed in the column.
  • Integer - Only numeric values, excluding decimals, constitute valid output for this column. Values will be parsed numerically and with a precision of 0.
  • Decimal - Only numeric values, including decimals, constitute valid output for this column. Values will be parsed numerically and with the specified precision (identified by the Precision property).
  • Percentage - Only numeric values, including decimals, constitute valid output for 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 will be displayed 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).

Enable Row Visibility By Value

When this option is enabled, it allows to make rows visible based on a row's value in this column. A True value indicates that the row is visible. False value hides the row.

If more than one column have this option enabled, the row is visible if at least one of such columns has value True in the row.

Precision

The precision constitutes the number of values post-decimal for numeric outputs that support decimal values. This is only available if the column's mask type is Decimal, Percentage, or Currency.

Visible in the Grid

Indicates whether the column is visible.

This can be configured as Always or Never to indicate whether the column is statically visible or not.

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.

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.