ReportDefaults()
Estimated reading time: 4 minutesFunction Summary
The ReportDefaults function will copy a value from a range to another range when triggered upon a designated event.
This function can be used to restore default values to a report after a desired action. For example, the values in the parameters section can be cleared after a clear event or set to a particular value. It can also be used to set initial parameters before a report is ran.
For an example of this function, see Lab Create: Customer Aging Detail.
Function Arguments
| Type | String |
| Constraints | "pull", "save", "both" |
| If Blank | Function Error |
| Type | String |
| Constraints | "clear", "run", "both" |
| If Blank | Function Error |
| Type | Pair()/PairGroup() |
| Constraints | Max 34 Pairs |
| If Blank | Does not transfer any values |
Excel Formula Bar Example
Excel
=ReportDefaults("Save","Clear",PairGroup(Pair("",C12,FALSE)))
Function Composition
| Argument Name | Example Mapping | Explanation |
|---|---|---|
| Function Name | =ReportDefaults() | The name of this function. |
| OnPullSaveOrBoth | "Pull" | A pull action is designated as the run event. |
| OnClearRunOrBoth | "Clear" | A clear event or run event (defined in OnPullSaveOrBoth) will trigger this function being ran. |
| TransferPairs | PairGroup(Pair("",C12,FALSE)) | Will copy a blank value to C12. |
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 |