Grooper Help - Version 25.0
25.0.0024 2,166

Data Grid Collection

Section Instance Collection Data Grid Element GrooperReview.DataGrid

Displays a collection of repeating records for a multi-instance Data Section in the Data Grid.

Remarks

The Data Grid Collection control displays a Section Instance Collection as a paged, interactive UI component. It is used to review, edit, and validate collections of records—such as line items, claims, or repeating form sections—within a document.

Purpose and Functionality

  • Displays each record in the collection as a separate page, allowing users to navigate, review, and edit individual records.
  • Integrates with the Page Navigator for paging through records using toolbar controls or keyboard shortcuts.
  • Shows the record's caption and error status, highlighting validation issues with visual indicators.
  • Hosts a Data Grid Container for the current record, enabling editing of all child fields, tables, and nested sections.
  • Provides a context menu with collection-level commands (e.g., add, delete, merge, move) for managing records.

Interactive Components

  • Toolbar:
    • Contains the Page Navigator for paging through records.
    • Displays the current record's caption and error status.
  • Record Display:
    • Renders the current record using the Data Grid Container control.
    • Supports editing, validation, and navigation of all child elements.
  • Context Menu:
    • Offers collection-level commands such as "Append Record", "Insert Record", "Delete Record", "Merge With Previous", "Move Previous/Next".
    • Commands are accessible via right-click or keyboard shortcuts (e.g., Ctrl + Insert to append).

Keyboard Navigation

  • Use Tab and Shift + Tab to move between fields and records.
  • Use Page Navigator controls or shortcuts to move between records.
  • Context menu commands are available via keyboard shortcuts for efficient record management.

Error Handling

  • Validation errors are indicated with a warning icon and tooltip in the toolbar.
  • The first error message for the collection is displayed as a tooltip for quick review.

Styling and CSS Class Names

This control and its child elements are assigned specific CSS class names to enable custom styling. These class names can be used from the CSS property of the Data Model or Data Section to apply custom styles to a Data Grid Collection:

  • The main control uses DataGridCollection.
  • The record display uses DataGridContainer and may include additional classes based on section or record type.
  • Toolbar and pager controls use PageNavigator and related class names.
  • Context menu uses ContextMenu and command-specific classes.
  • Child fields, tables, and sections inherit their own CSS class names, such as DataGridField, DataGridTable, or custom classes set on the Data Field, Data Table, or Data Section.
  • Additional classes may be applied dynamically based on validation state, workflow status, or custom configuration (e.g., error, confirmed, required).

These class names allow you to style the collection, records, fields, and navigation controls with high precision. For example:
.DataGridCollection { background: #f8f8f8; } .DataGridContainer.Claim { border-left: 4px solid #0077cc; } .DataGridField.Error { background: #ffe6e6; } .PageNavigator { font-weight: bold; }

For more information on CSS scoping and best practices, see CSS Builder.

How to Use

  1. Navigate between records using the toolbar or keyboard.
  2. Edit fields, tables, and nested sections within each record.
  3. Use context menu commands to add, delete, merge, or move records as needed.
  4. Review error indicators and resolve validation issues before saving.

Example

> Use DataGridCollection to review and edit all line items on an invoice, claims in an EOB, or repeating sections in a form. > Add new records, delete unwanted ones, and merge or reorder records to match the document's structure.

Related Components

For more information, see the documentation for Data Section, Section Instance Collection, Data Grid Container, and Page Navigator.

Context Menu Commands

Command Shortcut Description
content_copy Copy Field JSON Copies JSON data for the current field to the clipboard.
backup_table Copy JSON Copies JSON data for the current container to the clipboard.

Command Buttons

ButtonShortcut KeySummary
grid_off tabular Alt+T

Child Controls

NameTypeSummary

Used By

Notification