Data Grid Container

Displays a Document Instance or Section Instance as a container within the Data Grid.

Remarks

The DataGridContainer control presents a hierarchical container for document data, such as a Document Instance or Section Instance, within the Data Grid. It organizes and displays all child data elements—fields, sections, and tables—according to the document's schema.

Purpose and Functionality

• Serves as the main container for reviewing, editing, and validating grouped data elements in a document.
• Supports both root-level document containers and nested section containers, adapting to single-instance and multi-instance scenarios.
• Manages the display and interaction of all child elements, including expandable/collapsible sections, tabular data, and nested controls.
• Integrates with change tracking, error handling, and workflow features for efficient review and correction.

Interactive Components

• Child Controls:
  Renders all child Data Element Instances, including Data Field, Data Section, and Data Table controls.

  • The 'Children' control represents the collection of child elements, supporting navigation, editing, and validation.
  • Expand/collapse controls allow users to show or hide nested sections for focused review.

• Context Menu:
  Provides container-level commands via a right-click menu, including actions such as adding/removing sections, running extraction rules, or copying data.

  • The 'MenuModel' control adapts its available commands based on the container type, state, and workflow context.
  • Common commands include: Add Section, Delete Section, Run Rule, Validate All, Copy JSON.

• Add/Remove Section Buttons:

  • 'Add Section': Allows users to add an instance of an optional section.
    • Appears for multi-instance or optional sections; uses a toggle icon.
  • 'Delete Section': Allows users to remove an instance of an optional section.
    • Appears for removable sections; uses a toggle icon.
  • These buttons streamline the management of repeating or optional data groups.

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, Data Section, or Data Table to apply custom styles to a Data Grid Container:

• The main control uses DataGridContainer.
• Section containers use single or multi to indicate cardinality, and may include custom classes from the "CSS_Class" variable.
• Placeholder sections use placeholder.
• Computed states and workflow status may add additional classes (e.g., computed, error, confirmed).
• Child controls inherit their own CSS class names, such as DataGridField, DataGridTable, or custom classes set on the Data Field, Data Table, or Data Section.
• Add/remove section buttons use add_section and delete_section.
• Context menu uses ContextMenu and command-specific classes.

These class names allow you to style the container, sections, fields, and navigation controls with high precision. For example:
.DataGridContainer { background: #f4f4f4; } .DataGridContainer.multi { border-left: 4px solid #0077cc; } .DataGridContainer.placeholder { opacity: 0.5; } .DataGridField.Error { background: #ffe6e6; } .add_section { color: #007700; } .delete_section { color: #cc0000; }

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

Appearance and Customization

• Support///

Error Handling and Validation

• Highlights invalid or missing values within the container and its children.
• Integrates with change tracking and validation workflows, supporting error navigation and correction.
• Provides commands for running extraction rules, validating all data, and rubberbanding new records.

Accessibility & Usability

• Keyboard navigation is supported for efficient review and editing.
• Context menus and buttons provide quick access to common actions.
• Expand/collapse controls and visual cues guide users through complex document structures.

Example Workflow

1. Open a document in the Data Grid.
2. The DataGridContainer displays the root container or a section, organizing all child fields and tables.
3. Expand sections to review nested data, add or remove optional sections as needed.
4. Use context menu commands to run rules, validate data, or copy information.
5. Save changes and resolve any errors or validation issues.

Related Concepts

• Data Grid: Hosts the DataGridContainer for each document or section.
• Document Instance, Section Instance: The runtime data objects displayed by the container.
• Data Field, Data Table: Child elements organized within the container.
• Context Menu: Provides container-level commands and workflow actions.
• CSS Builder: Manages styling and appearance for containers and child elements.

For more information, see the documentation for Data Grid, Document Instance, Section Instance, and CSS Builder.

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

Button	Shortcut Key		Summary
toggle_off add_section		►	Adds an instance of an optional section to the container. Overview The add ection button allows users to insert a new instance of an optional or multi-instance Data Section within the container. Purpose and Functionality Appears for sections that support multiple instances or are marked as optional. Streamlines the management of repeating or optional data groups, such as adding a new address or claim entry. Uses a toggle icon to indicate the action. How to Use Click the add_section button to create a new instance of the section. The new section will appear in the container, ready for data entry and review. Example > Click the add_section button to add another "Line Item" to an invoice.
toggle_on delete_section		►	Removes an instance of an optional section from the container. Overview The delete section button allows users to remove an existing instance of an optional or multi-instance Data Section from the container. Purpose and Functionality Appears for sections that can be removed, such as optional or repeating groups. Helps maintain accurate document data by allowing users to delete unnecessary or incorrect section instances. Uses a toggle icon to indicate the action. How to Use Click the delete_section button to remove the selected section instance. The section will be deleted from the container, and its data will no longer be included in the document. Example > Click the delete_section button to remove an extra "Claim Entry" from a medical form.

Child Controls

Name	Type		Summary
Children	Data Grid Element	►	Displays one or more child controls for the current container. Overview The Children control renders all child Data Element Instances within the current Document Instance or Section Instance. This includes Data Field, Data Section, and Data Table controls, organized according to the document schema. Purpose and Functionality Presents all nested data elements for review, editing, and validation. Supports hierarchical navigation, expand/collapse of sections, and paging for multi-instance elements. Enables users to interact with each child element, including entering values, correcting errors, and launching context menus. How to Use Child controls are automatically displayed within the container, reflecting the structure of the underlying data model. Click to expand or collapse sections, and use keyboard navigation to move between fields and tables. Context menus and validation indicators are available for each child element. Example > Expand the "Vendor Information" section to view and edit all vendor-related fields and tables.
Menu Model	Context Menu	►	Displays commands which apply to this container instance via a context menu. Overview The Menu Model control provides a right-click context menu for the current container, offering commands relevant to the Document Instance or Section Instance. Purpose and Functionality Offers quick access to container-level actions such as adding/removing sections, running extraction rules, validating data, and copying JSON. Adapts its available commands based on the container type, state, and workflow context. Supports both standard and custom actions, including integration with batch processing and review workflows. How to Use Right-click anywhere in the container area to open the MenuModel context menu. Use arrow keys to navigate, Enter or Space to execute, and Escape to close. Common commands include: Add Section, Delete Section, Run Rule, Validate All, Copy JSON. Example > Right-click a section to add a new instance, run a rule, or copy its data as JSON.

Used By

Data Grid CollectionData Grid ContainerData Grid Document