ReportGrouping()

Estimated reading time: 5 minutes

Function Summary

The ReportGrouping function will collapse or expand groups within the sheet when triggered upon a designated event. This function is helpful in grouping or ungrouping sections in a ReportVariable after it is generated.

For an example of this function, see Lab Create: Inventory Variable Report.

Function Arguments

Type String
Constraints "pull", "save", "both"
If Blank Function Error

Type String
Constraints "clear", "run", "both"
If Blank Function Error

Type String
Constraints "row", "column"
If Blank Function Error

Type String
Constraints "expand", "collapse", or 1 through 8
If Blank Function Error

Type Boolean
Constraints
If Blank False

Excel Formula Bar Example

=ReportGrouping("Both","Run","Column","Collapse",FALSE)

Function Composition

Argument Name Example Mapping Explanation
Function Name =ReportGrouping() The name of this function.
OnPullSaveOrBoth "Both" A pull or save action are designated as the run event.
OnClearRunOrBoth "Run" A run event (defined in OnPullSaveOrBoth) will trigger this function being ran.
RowOrColumnGroup "Column" Only column groupings will be acted upon when this function is triggered.
GroupLevel "Collapse" The column groupings will collapse upon being triggered.
Disabled FALSE This function will run.

Trigger Combination List

The execution of this function is determined by a combination of an Interject action and an Interject event. An action is a pull or save action whereas an event is a clear or run event. The values in the OnPullSaveOrBoth and OnClearRunOrBoth arguments will determine what actions/events trigger the function's execution.

Trigger Combo OnPullSaveOrBoth OnClearRunOrBoth Event Function Executes On
1 Pull Clear Pull-Clear
2 Save Clear Save-Clear
3 Both Clear Pull-Clear, Save-Clear
4 Pull Run Pull-Run
5 Save Run Save-Run
6 Both Run Pull-Run, Save-Run
7 Pull Both Pull-Run, Pull-Clear
8 Save Both Save-Run, Save-Clear
9 Both Both Pull-Run, Pull-Clear, Save-Run, Save-Clear