This is a generic base class for tools.
This class cannot be extended directly, instead refer to CustomToolTContext,
Inheritance Hierarchy
Spotfire.Dxp.ApplicationTool
Spotfire.Dxp.ApplicationToolTContext
Spotfire.Dxp.Application.ExtensionCustomToolTContext
Spotfire.Dxp.ApplicationShareToolTContext
Spotfire.Dxp.Application.ToolsExportTool
Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 30.0.10915.3380 (30.0.10915.3380)
Syntax
C#
public abstract class Tool<TContext> : Tool where TContext : class
Type Parameters
- TContext
- The type that this tool operates on, that is, the context of the tool.
The ToolTContext type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() | Execute |
Executes the tool for the specified context.
If IsEnabled(TContext) returns false, this method does nothing.
|
![]() | ExecuteAndPrompt |
Executes the tool for the specified context.
If IsEnabled(TContext) returns false, this method does nothing.
|
![]() | ExecuteAndPromptCore |
Implement this method to perform tool-specific logic.
|
![]() | ExecuteCore |
Implement this method to perform tool-specific logic.
|
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetSupportsPromptingCore |
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.
|
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsEnabled |
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.
|
![]() | IsEnabledCore |
Override this method to control when the tool is enabled.
|
![]() | IsVisibleCore |
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.
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
Version Information
See Also