Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Combine

Base Combining Provider Grooper.Extract

Combines instances from child extractors based on the grouping specified in the Group By property.

Remarks

The CombineProvider class collates and merges extraction results from multiple child extractors, grouping them according to the selected strategy.

How it works:

  • All results from child extractors are collected and grouped based on the value of the 'GroupBy' property.
  • Each group is then combined into a single output instance using the method specified by the 'CombineMethod' property (inherited from BaseCombiningProvider).

Grouping strategies:

  • 'None': All results are combined into a single group.
  • 'Row': Results that align horizontally are grouped together.
  • 'Column': Results that align vertically are grouped together.

Additional options:

  • If 'EnforcePageBoundaries' is set to true, results will not be grouped across page boundaries.

Related properties:

  • 'GroupBy': Determines the grouping axis or disables grouping.
  • 'EnforcePageBoundaries': Prevents groups from spanning multiple pages.
  • 'CombineMethod', 'ResultSeparator', 'OutputElement', and 'ContextElement' (inherited): Control how grouped results are merged and formatted.

> Note: The grouping and combining logic enables extraction of structured data such as table rows or columns, or the merging of related values into a single result.

Properties

NameTypeDescription
General
Combine Options

Used By

Notification