Skip to content
REFERENCE

U.PROFILE_WORKBOOK

Summary

Measures the calculation time of each group of formulas in the workbook and creates a report showing ranges and calc times with slowest on top

Syntax

=U.PROFILE_WORKBOOK([granularity], [current_sheet_only], [num_recalcs], [timeout_in_mins], [quick_calc])

Parameters

Parameter Required Description
[granularity] No Set to specify the size of calculated ranges. Supported values are "WORKSHEET", "REGION", "FORMULA" and "CELL". Default is "FORMULA". Or set to "REPORTS" to see a report of cached profile reports previously run, "CLEAR" to clear all previous profile reports from the cache, or "STOP" to stop a profiling session running in another Excel instance
[current_sheet_only] No Set to TRUE to profile only the current worksheet. By default all worksheets in the workbook are profiled
[num_recalcs] No Set to a positive integer to have calculations performed multiple times and results averaged. By default calculations are performed only once (meaningful differences when using average of multiple calculations have not been observed). Max of 10 is enforced
[timeout_in_mins] No The timeout in minutes after which the profiling job will be aborted if it has not already completed. By default it will be allowed to run for up to 8 hours, though usually it completes within a minute or two. Set to -1 for an infinite timeout
[quick_calc] No If set to TRUE then some cleanup between calcs is skipped to speed up the profiling. This could lead to instability in some larger workbooks, resulting in the need to click Excel or press the Escape key after the profiling completes for Excel to become interactive again. Default is FALSE

Behavior

The documented public interface is supported by the current U Add-in source signature and the maintained Usage Examples workbook. Optional parameters are shown in square brackets in the syntax above; omit the brackets when entering a formula.

Return Value

Returns the function result or action status described by the formula and parameters above. The maintained sources do not define a narrower, stable return contract for this function.

Examples

=U.PROFILE_WORKBOOK()

Notes

  • Formula examples are preserved from maintained workbook usage and normalized to the current U. prefix.
  • Complete formulas demonstrate working patterns; they do not imply that undocumented option values are supported.
  • Where maintained sources do not specify every accepted value, default, or error message, this page does not infer one.
  • For functions that perform actions, use a visible trigger or supported block/throttle parameter to avoid unintended repetition during recalculation.