Datagrid

This topic describes the options and limitations available when using a Datagrid component.

Content settings

Columns

This setting makes these column specifications:

• The number of columns
• Addition or deletion of columns as needed

To make the settings for a particular column, click the name of that column in the list. This opens the Edit Datagrid Column dialog box. Use that dialog box to make these settings:

• The name for each column, as it appears in the Datagrid header row
• The source of the content for each column's cells
• Options to make each column editable, resizable, and/or sortable.
• The type of formatting to apply to the content of cells in each column.

  See Defining a Datagrid column.

• Inclusion of a summary row, used to total a set of numeric values for the column.

Header

This setting specifies the text to display as the header (title) for the Datagrid component. Specify both a Source and a Display Value.

Options

These settings specify various aspects of the Datagrid's behavior, including these:

• Keep Selection

  When selected, this option indicates that any record that is selected when the collection is refreshed, remains selected after the collection is refreshed.

  When this option is cleared, after the collection is refreshed, the focus returns to the first record in the collection.

• Selectable

  When selected, this option specifies that records in the grid can be selected and modified by the user.

  When this option is cleared, the user can view selected records (which are highlighted), but the contents are read-only.

• Multi Select

  When selected, this option causes a column with check boxes for each record to display. These check boxes allow users to select multiple records for further action.

Toolbar

These settings determine what information is to be displayed in the Datagrid toolbar. The toolbar information displays at the top of the Datagrid component.

Header. For the toolbar to be visible, you must select the Show Header option on the the Style tab.

• Enable Row Count

  When selected, this option displays the number of records in the current collection, inside parentheses ( ) next to the Header text.

  When this option is cleared, no record count displays.

• Enable Filter Bar

  When selected, this option displays a magnifying glass icon on the right side of the toolbar. This magnifying glass icon allows you to filter the contents of the Datagrid, so that only records that contain the filter criteria display. To use the filter, you must click the icon and type in the field the string you want to search for. Then press Enter. The Datagrid component then displays only the records that contain that string.

  Note: You can filter only one string at a time. Boolean searches are not allowed.

  When this option is cleared, the filter feature is not available.

• Enable Export

  When selected, this option displays an Export button on the Datagrid toolbar. In Preview or Launch mode, you can then export the data in the Datagrid to an Excel or CSV-formatted file.

Paging

These settings determine how many records are to be displayed in the Datagrid at any one time.

• Use Paging

  When selected, only a specified number of records display in the Datagrid at any one time. Users can access/view additional records using the paging controls at the bottom of the grid.

  When this option is cleared, all records display, and the system ignores any Items per page setting.

• Items per page

  When the Use Paging option is selected, use this drop-down list to select the number of records to display on each page.

  If the Use Paging option is not selected, any value in this field is ignored.

Interactions

Trigger Event

The Datagrid component can trigger these events:

• On Selection Changed

  This event is triggered when the selection of a record in the Datagrid changes.

• On Row Updated

  This event is triggered when any of the data in a record (row) is updated.

• On Cell Updated

  This event is triggered when any of the data in an individual cell is updated.

• On Button Clicked

  This event is triggered when an associated button is clicked.

• On Load: This event might display as one of these values:
  • Data Service has run (On Load), where Data Service is the name of a data service assigned to the Datagrid component
  • On Load (No Data Service), where no data service has been assigned to the Datagrid component

Target Action

Depending on the target, the Datagrid component can perform a Get operation, a Run operation, or a Clear operation on the target component.

Style settings

Style

This setting has one option: Show Header

When this option is selected, the header (title) for the Datagrid component displays above the grid. If other toolbar options (such as the row count and filter settings) are active, they also display.

When this option is cleared, no header row information displays.

List

This setting has one option: Display as List

When this option is selected, the grid does not display separator lines between the columns.

Row Height

This setting has three options: Small, Medium, and Large

These options determine the relative height of the rows.