Skip to content
REFERENCE

U.EVENT

Summary

Returns TRUE only when specified, path-dependent conditions are met

Syntax

=U.EVENT(watched_values, [trigger_threshold], [set_threshold], [reversion], [max_triggers], [show_labels], [reset], [calc_on_trigger])

Parameters

Parameter Required Description
watched_values Yes The values that will be watched and whose changes can result in a trigger event
[trigger_threshold] No The level(s) that must be breached by a watched value in order for a trigger event to occur. A direction can optionally be specified in a second column. If not provided then value changes are trigger events
[set_threshold] No The level(s) that must be breached by a watched value in order for a trigger to be enabled. A direction and initial state can optionally be provided. If not provided then event is always enabled
[reversion] No How a state of triggered (method returning TRUE) will revert to not triggered (method returning FALSE). See table to the left for a description of supported values
[max_triggers] No The maximum number of times the event will fire. An optional 2nd column value can be used to specify how many events are skipped before the event fires for the first time. An optional 3rd column value can specify how many checks to ignore after opening the workbook. Default is unlimited firing with no skipped events or checks.
[show_labels] No If set to TRUE then labels for returned values will be included. Default is false
[reset] No If set to TRUE then the event will be fully re-initialized, including the count of times fired to date being set back to zero. This parameter should not be left as TRUE
[calc_on_trigger] No If set to a range references ...or ref IDs as returned from U.RANGE_REF... the referenced range will be recalculated when the method triggers. If set to TRUE (or "self") then the method will recalculate itself immediately after it triggering; if set to a number, it will recalc itself after that many seconds. Include "churn_ok" as a value to disable churn prevention.

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.EVENT(B5,C7)

=U.EVENT(B23,C26:D26,C27:E27,C28,C29,TRUE,C30)

=U.EVENT(B60,C63:D63,C64:E64,C65,C66,TRUE,C67)

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.