InternalEventExecutionMode Enumeration

Spotfire 14.2 API Reference
Controls how an internal event handler should be executed in the different views of the document. A document has multiple views if the user has opened multiple browser tabs for the document in the web client, or if a javascript mashup uses multiple views.

Each view of the document can have different values for active page, active visualization, active data table, active marking, and active filtering selection. The value of these properties depends on the currently active view of the document. We will refer to these properties as view properties.

Namespace:  Spotfire.Dxp.Framework.DocumentModel
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
public enum InternalEventExecutionMode
Members

  Member nameValueDescription
ExecuteWithoutView0 An event handler that is declared to execute in this mode may not get or set any view property. The event handler is only executed once each time it is triggered, even if there are multiple views of the document.

This mode should be used if the event handler does not get or set view properties, because it leads to best performance.

ExecuteInAffectedViews1 An event handler that is declared to execute in this mode may get or set view properties. The event handler is executed for each document view where the event was triggered. Thus, if there are multiple views of the document, then the event handler may be executed multiple times.

Note that, if an ordinary property was modified then the event will be executed in all views where the trigger fires. This may have performance implications so this mode should only be used if the event handler needs to get or set view properties.

ExecuteInCurrentView2 An event handler that is declared to execute in this mode may get or set view properties. The event handler is executed in the document view where the event was triggered.

Note that, if an ordinary property was modified then that affects all views but the event will still only execute in the view that was active when the modification took place. This ensures that the event is executed only once which is good for performance. However, the event handler may not be able enforce the invariant it is intended to enforce, in all views.

This mode is rarely useful. It is provided primarily for backwards compatibility purposes and is the default for the previously existing API, because it is a trade off between the two other modes.

Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference