AddIn Class TIBCO Spotfire 7.6 API Reference
Base class for TIBCO Spotfire AddIns. An AddIn is used to extend the application with new functionality.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Application.ExtensionAddIn

Namespace: Spotfire.Dxp.Application.Extension
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax

C#
public abstract class AddIn : IAddIn

The AddIn type exposes the following members.

Constructors

  NameDescription
Protected methodAddIn
Initializes a new instance of type AddIn.
Top
Methods

  NameDescription
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAnalysisServicesRegistered
Override this method to lookup and access analysis services during the per-analysis startup phase of the application.
Protected methodOnGlobalServicesRegistered
Override this method to lookup and access global services during the global startup phase of the application.
Protected methodOnUserServicesRegistered
Override this method to lookup and access user services during the per-user startup phase of the application.
Protected methodRegisterAnalysisServices
Override this method to register one or more analysis services with the application.
Protected methodRegisterApplicationEventHandlers
Override this method to register one or more application event handlers. These are objects of classes deriving from CustomApplicationEventHandler.
Protected methodRegisterCalculations Obsolete.
Override this method to extend the application with new calculations. For each new calculation, it is registered with the AddInCalculationRegistrar.
Protected methodRegisterDataAdapters
Override this method to extend the application with new data adapters. For each new type of data adapter, a DataAdapterFactory is registered with the DataAdapterRegistrar.
Protected methodRegisterDataFunctionExecutors
Override this method to register data function executors with the application.
Protected methodRegisterDataMethods
Override this method to extend the application with new data methods (e.g. aggregation methods). For each new data method, it is registered with the AddInDataMethodRegistrar.
Protected methodRegisterDataSources
Override this method to extend the application with new data sources. For each new type of data source, a DataSourceFactory is registered with the AddInDataSourceRegistrar.
Protected methodRegisterDataTransformations
Override this method to extend the application with new data transformations. For each new type of data transformation, a DataTransformationFactory is registered with the AddInDataTransformationRegistrar.
Protected methodRegisterDataWriters
Override this method to extend the application with new data writers. For each new type of data writer, a DataWriterFactory is registered with the AddInDataWriterRegistrar.
Protected methodRegisterFittingModels
Override this method to register custom fitting models with the application. For each new type of fitting model, a FittingModelFactory is registered with the AddInFittingModelRegistrar.
Protected methodRegisterGlobalServices
Override this method to register one or more global services with the application.
Protected methodRegisterHelp
Override this method to register help items with the application.
Protected methodRegisterPanels
Protected methodRegisterPreferences
Override this method to register custom preferences with the application. For each new type of preference, a CustomPreference is registered with the AddInPreferenceRegistrar.
Protected methodRegisterProperties
Override this method to register custom properties with the application. Each property will be added to the DataPropertyRegistry.
Protected methodRegisterTools
Protected methodRegisterTypeBindings
Override this method to register type bindings used to resolve backward compatibility deserialization issues for .dxp files.
Protected methodRegisterUserServices
Override this method to register one or more user services with the application.
Protected methodRegisterValueRenderers
Override this method to register value renderer producers with the application. For each new type of value renderer producer, a ValueRendererFactory is registered with the AddInValueRendererRegistrar.
Protected methodRegisterViews
Override this method to register views for model objects such as tools. Each new view is registered with the AddInViewRegistrar.
Protected methodRegisterVirtualColumnProducers
Override this method to register virtual column producers with the application. For each new type of virtual column producer, a VirtualColumnProducerFactory is registered with the AddInVirtualColumnRegistrar.
Protected methodRegisterVisuals
Override this method to extend the application with new visuals (e.g. plots). For each new type of visual, a VisualFactory is registered with the AddInVisualRegistrar.
Top
Remarks

Inherit from this class and override one or more of the Register methods to register extensions, for example a CustomToolTContext or CustomDataSource.

An AddIn may not throw exceptions during its initialization. If it does, TIBCO Spotfire will crash at startup.

Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference