This is the base class for tools, that is, functionality
available through the tools menu and on various context menus.
A tool can be launched by calling its
Execute(TContext) method.
The ContextType property determines the type of
context object the tool expects in the
Execute(TContext) method call.
For example, a tool with a ContextType of Page
would expect a page (typically the ActivePageReference)
to be passed to it.
Tools can belong to different categories. The category might affect where the tool is rendered in the Spotfire user interface. However, the category and the context of a tool are not interconnected. That is, two different tools may share the same context but have different categories.
Tools are accessed via the Toolbox.
Inheritance Hierarchy
Spotfire.Dxp.ApplicationTool
Spotfire.Dxp.ApplicationToolTContext
Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
public abstract class Tool
The Tool type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetToolbarIdCore |
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.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also