ExternalEventManager Class

Spotfire 14.2 API Reference
A manager for external event handlers.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelExternalEventManager

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 sealed class ExternalEventManager : IComponent, 
	IDisposable

The ExternalEventManager type exposes the following members.

Constructors

  NameDescription
Public methodExternalEventManager
Initializes a new instance of the ExternalEventManager class.
Public methodExternalEventManager(IContainer)
Initializes a new instance of the ExternalEventManager class.
Top
Methods

  NameDescription
Public methodAddEventHandler
Adds an event handler which is called when any of the triggers fire.
Public methodAddThreadSafeEventHandler
Adds a thread safe event handler which is called when any of the triggers fire.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Public eventDisposed
Implements IComponent.
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate propertyIComponentSite
Implements IComponent.
Top
Remarks

Create an instance of this class to listen to external events from the document. Dispose the instance when external events from the document are no longer of interest.

When one or more of the document nodes that are listened to with an ExternalEventManager are removed from the document, the ExternalEventManager instance must be disposed. This is required by the document model framework in order to avoid memory leaks.

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