CustomToolTContext Class

Spotfire 14.2 API Reference
This class is the base class to use when creating a custom tool.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.ApplicationTool
    Spotfire.Dxp.ApplicationToolTContext
      Spotfire.Dxp.Application.ExtensionCustomToolTContext

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

C#
public abstract class CustomTool<TContext> : Tool<TContext>
where TContext : class

Type Parameters

TContext
The type that this tool operates on, that is, the context of the tool. Currently, the following types are supported:

AnalysisApplication - Available from the Tools menu

Document - Available from the Tools menu

Page - Available from the context menu for the Page tabs

Any of the built-in visuals (for example ScatterPlot- Available from the context menu for the visual.

The CustomToolTContext type exposes the following members.

Constructors

  NameDescription
Protected methodCustomToolTContext(String)
Initializes a new instance of the CustomToolTContext class.
Protected methodCustomToolTContext(String, LicensedFunction)
Initializes a new instance of the CustomToolTContext class.
Protected methodCustomToolTContext(String, LicensedFunction, MenuCategory)
Initializes a new instance of the CustomToolTContext class.
Protected methodCustomToolTContext(String, LicensedFunction, ToolCategory) Obsolete.
Initializes a new instance of the CustomToolTContext class.
Protected methodCustomToolTContext(String, LicensedFunction, MenuCategory, ExtensionIcon)
Initializes a new instance of the CustomToolTContext class.
Protected methodCustomToolTContext(String, LicensedFunction, MenuCategory, Image) Obsolete.
Initializes a new instance of the CustomToolTContext class.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecute
Executes the tool for the specified context. If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from ToolTContext.)
Public methodExecuteAndPrompt
Executes the tool for the specified context. If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from ToolTContext.)
Protected methodExecuteAndPromptCore
Implement this method to perform tool-specific logic.
(Inherited from ToolTContext.)
Protected methodExecuteCore
Implement this method to perform tool-specific logic.
(Inherited from ToolTContext.)
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetMenuTextCore
Gets the menu text for the tool. Override this method and return a string based on CurrentUICulture in order for the web player user interface to adapt to the localization settings of the web client user.
Protected methodGetSupportsPromptingCore
Override this method to return a value indicating whether this tool supports the ExecuteAndPrompt method which enables asynchronous prompting e.g. on the Web Player.
(Inherited from ToolTContext.)
Public methodGetToolbarIdCore
Gets the identifier used by the custom toolbar. This is the string that you add to the ToolbarShortcuts preference if you want your tool to be visible in the toolbar. The default value is the name of the type. Override this method if you want to provide your own identifier string.
(Inherited from Tool.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsEnabled
Gets whether or not the tool is enabled for the specified context. If context is null or not of the type specified by ContextType, false is always returned.
(Inherited from ToolTContext.)
Protected methodIsEnabledCore
Override this method to control when the tool is enabled.
(Inherited from ToolTContext.)
Protected methodIsVisibleCore
Gets whether or not the tool should be visible in the application given its context. Hiding a tool will remove it from the user interface of its context and prevent usage. Override with a custom implementation to control when the tool is visible.
(Inherited from ToolTContext.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
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