Skip to content
REFERENCE

U.RUN_SCRIPT

Summary

Runs a script created using the U.CREATE_SCRIPT method

Syntax

=U.RUN_SCRIPT(script_name, [confirm], [log_range], [display_alerts], [auto_calc_mode], [ignore_errors], [block])

Parameters

Parameter Required Description
script_name Yes The name of the script to run If set to FALSE and steps are not set, then any currently running script in the Excel instance will be killed
[confirm] No If set to TRUE then a confirmation message box will be presented to the user before the script is run If set to FALSE, then the specified script will be killed if it is currently running
[log_range] No If set to a range, that range will be used to display script status messages instead of any log range that may have been defined in the script being run
[display_alerts] No If set to TRUE then alerts are displayed while the script is run. By default alerts are suppressed
[auto_calc_mode] No If set to TRUE then the workbook will be in automatic calculation mode while the script is run. By default the workbook is placed in manual calculation mode during the running of the script …and calculated by the script after each step… to minimize the risk of unwanted calculation artifacts
[ignore_errors] No If set to TRUE or FALSE, will be applied to every step in the script overriding any default and step-specific settings that may have been specified when the script was created
[block] No If set to TRUE then method will not be calculated unless triggered by user interaction or calculated as a step in a script; If set to a number then will be throttled to not calculate more frequently than the specified number of seconds; make number negative to prevent auto recalc of blocked methods. If a 2nd column is provided and set to TRUE script will not be queued

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.RUN_SCRIPT(C4,TRUE)

=U.RUN_SCRIPT(C6,TRUE,,,,,TRUE)

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.