Key-Value Pair

If set to true, excludes key-value pairs from consideration if a horizontal or vertical line separates the key from the value.

• This helps prevent incorrect pairing across table or form lines.
• Depends on Layout Data generated by the Line Detection or Line Removal IP commands during Image Processing or Recognize.
• Ensure input documents have been processed with line detection/removal for this feature to work.

Can be one of the following values:

Controls the matching direction for key-value pairs when the vertical layout is enabled.

• Set to 'Forward' to match keys above values, 'Reverse' for values above keys, or 'Either' for both.
• Only visible when the 'VerticalLayout' property is set.

Can be one of the following values:

Controls the matching direction for key-value pairs when the horizontal layout is enabled.

• Set to 'Forward' to match keys to the left of values, 'Reverse' for values to the left of keys, or 'Either' for both.
• Only visible when the 'HorizontalLayout' property is set.

Can be one of the following values:

Controls the matching direction for key-value pairs when the flow layout is enabled.

• Set to 'Forward' to match keys before values in the text flow, 'Reverse' for values before keys, or 'Either' for both.
• Only visible when the 'FlowLayout' property is set.

If set, arrays with more than this number of non-matching (noise) characters in their bounding region will be excluded from the results.

This is useful for improving result quality in noisy documents, such as forms with extraneous marks or text between array elements.

Used by all derived array providers.

• If 'ReturnChildValues' is true, each matched value from the extractors is returned as a separate result.
• If 'ReturnChildValues' is false, a single combined instance is returned for each array, containing all matched values as children.

Use 'ReturnChildValues' = true to analyze or process raw results from each extractor separately; use false to treat the array as a single logical unit.

Use 'MatchLimit' to improve performance or relevance when extracting values that may be repeated many times in large documents.

For example, in a multi-page document where the same value appears on every page, setting 'MatchLimit' to 1 will stop after the first match is found.

Applies to all derived array providers.

Can be one of the following types:

If set, the provider will attempt to detect arrays where elements are aligned horizontally (e.g., table rows).

Used by ArrayProvider, OrderedArrayProvider, and KeyValueProvider to support horizontal grouping.

Can be one of the following types:

If set, the provider will attempt to detect arrays where elements are aligned vertically (e.g., table columns).

Used by ArrayProvider, OrderedArrayProvider, and KeyValueProvider to support vertical grouping.

Can be one of the following types:

If set, the provider will attempt to detect arrays where elements occur sequentially in the text flow (e.g., lists or inline fields).

Used by ArrayProvider, OrderedArrayProvider, and KeyValueProvider to support flow-based grouping.

Can be one of the following values:

The CombineType enumeration specifies the strategy used to combine multiple extraction results into a single output value.

Can be one of the following values:

The 'ResultSeparator' property defines the string inserted between each result when combining values.

Special escape sequences supported:

• \\r - Carriage return
• \\n - Line feed
• \\t - Tab
• \\f - Form feed
• \\s - Space

Only used when 'CombineMethod' is set to 'Individual'.

The 'OutputElement' property specifies which child extractor or group provides the output value when using the 'Group' combine method.

Only used when 'CombineMethod' is set to 'Group'.

The 'ContextElement' property specifies an additional extractor or group to provide context for the output value when using the 'Group' combine method.

Only used when 'CombineMethod' is set to 'Group' and 'OutputElement' is set.