Data Table

Data Table objects are used to describe tabular data for the purposes of Data Extraction during Extract and Data Review. The columns in the table are defined by adding child Data Column elements to a Data Table object.

Inherits from: Data Element

Properties

The following 22 properties are defined.

Property Name Description
General
Extract Method Type: Table Extract Method

Specifies the method to be used for table extraction.

Initial Row Count Type: Int32, Default: 0

The number of rows the table is to be initialized with. Specifies the number of rows which should be present in a newly-created instance of the table. This value also serves as a minimum row count for data extraction. If data extraction produces less rows, blank rows will be added to make up the difference.

Maximum Display Rows Type: Int32, Default: 0

The maximum number of rows to display. When set to 0, all rows in the table will be displayed, and scollbars will not be used.

Description Type: String

Specifies a description for the item.

Appearance
Cell Border Style Type: DataGridViewCellBorderStyle, Default: Single

The cell border style to use for this table. Can be one of the following values:

  • Custom - A border that has been customized.
  • Single - A single line border.
  • Raised - A three-dimensional raised border.
  • Sunken - A three-dimensional sunken border.
  • None - No borders.
  • SingleVertical - A vertical single-line border.
  • RaisedVertical - A vertical three-dimensional raised border.
  • SunkenVertical - A vertical three-dimensional sunken border.
  • SingleHorizontal - A horizontal single-line border.
  • RaisedHorizontal - A horizontal three-dimensional raised border.
  • SunkenHorizontal - A horizontal three-dimensional sunken border.
Background Color Type: Color, Default: Control

The background color for this item.

Foreground Color Type: Color, Default: ControlText

The foreground color for this item.

Visible Type: Boolean, Default: True

Controls whether this item is visible in the user interface.

Label Position Type: LabelPositionEnum, Default: Left

Controls how the label for this item is displayed. Can be one of the following values:

  • Left - The label is displayed to the left of the item.
  • Above - The label is displayed above the item.
  • Below - The label is displayed below the item.
  • None - The label will not be displayed.
Label Alignment Type: ContentAlignment, Default: MiddleLeft

The text alignment to be used for the data element's label. Can be one of the following values:

  • TopLeft - Content is vertically aligned at the top, and horizontally aligned on the left.
  • TopCenter - Content is vertically aligned at the top, and horizontally aligned at the center.
  • TopRight - Content is vertically aligned at the top, and horizontally aligned on the right.
  • MiddleLeft - Content is vertically aligned in the middle, and horizontally aligned on the left.
  • MiddleCenter - Content is vertically aligned in the middle, and horizontally aligned at the center.
  • MiddleRight - Content is vertically aligned in the middle, and horizontally aligned on the right.
  • BottomLeft - Content is vertically aligned at the bottom, and horizontally aligned on the left.
  • BottomCenter - Content is vertically aligned at the bottom, and horizontally aligned at the center.
  • BottomRight - Content is vertically aligned at the bottom, and horizontally aligned on the right.
Header Row
Display Header Row Type: Boolean, Default: True

Determines whether a column header appears at the top of the table.

Header Row Font Style Type: FontStyle, Default: Regular

The font style to use for the header row.

Header Foreground Color Type: Color, Default: ControlText

The background color for the table column headers.

Header Background Color Type: Color, Default: Control

The background color for the table column headers.

Total Row
Display Total Row Type: Boolean, Default: False

Controls whether a total row will be displayed at the bottom of the table.

Total Row Font Style Type: FontStyle, Default: Regular

The font style to use for the total row.

Total Row Foreground Color Type: Color, Default: ControlText

The background color for the table column headers.

Total Row Background Color Type: Color, Default: Control

The background color for the table column headers.

Total Columns Type: List of Data Column

Any columns selected in this list will be summed in the total row at the bottom of the table.

Behavior
Lookups Type: List of Lookup Specification

A list of lookup operations to be performed on child elements of this container. Each Lookup Specification defines a lookup operation, where the value of one or more Grooper fields will be used to query an external data source, such as a database. The results of the query can be used to validate existing field values or populate additional field values.

Lookup Specifications are executed at the following times:

  • Immediately after Extract runs, all lookup specifications in the Data Model will be executed.
  • When the value of a field is changed by a user, all lookup specifications referencing that field will be executed.
  • When a user manually triggers a lookup in the Index Panel to resolve a case where duplicate results were returned.
Preserve Character Data Type: Boolean, Default: False

Indicates whether character-level position and confidence data should be saved. If true, character-level detail will be saved with the data element. If false, only the raw text of the element's value will be saved. As storing this information increases storage requirements and reduces performance, this feature should only be enabled for individual data elements in cases where it is needed.

Character-level data can be useful in custom activities or custom export sceanrios, and is also used in certain built-in Grooper activities.
Rubberband OCR Profile Type: OCR Profile

The OCR Profile to use for rubberband OCR.

Commands

Command Name Shortcut Keys Description
Add Multiple Items Creates multiple items as children of the selected object.
Clear Children Deletes all children of the selected object(s).
Export to Zip Archive Exports a set of Grooper nodes to a ZIP archive.
Publish to Grooper Repository Publishes one or more Nodes to one or more Target Grooper Repositories.
Unpublish Unpublishes a set of Grooper Nodes to a Target Grooper Repository.

Tabs

Tab Name Description
Data Element - GeneralProvides a user interface displaying the properties of a Data Element as well as an interface for testing the Data Element on test Batch documents.
Grooper Node - ScriptingProvides script viewing, compilation, management, and basic editing features.
Grooper Node - ContentsProvides a user interface for viewing and managing the children of a Grooper Node.
Grooper Node - AdvancedDisplays detailed information about Grooper Node objects, and provides administrative functions for managing them.

See Also

Data Column, Lookup Specification, OCR Profile, Table Extract Method

Used By

Data Connection - Create Table, Export Mapping, Train Lexicon