Tool< TContext> Class TIBCO Spotfire 7.6 API Reference
This is a generic base class for tools. This class cannot be extended directly, instead refer to CustomTool<TContext>,
Inheritance Hierarchy
System. Object
  Spotfire.Dxp.Application.Tool
    Spotfire.Dxp.Application.Tool<TContext>
      Spotfire.Dxp.Application.Extension.CustomTool<TContext>
      Spotfire.Dxp.Application.ShareTool<TContext>
      Spotfire.Dxp.Application.Tools.ExportTool

Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
Copy
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 Tool< TContext> type exposes the following members.

Methods
  NameDescription
Public methodExecute
Executes the tool for the specified context. If IsEnabled(TContext) returns false, this method does nothing.
Public methodExecuteAndPrompt
Executes the tool for the specified context. If IsEnabled(TContext) returns false, this method does nothing.
Protected methodExecuteAndPromptCore
Implement this method to perform tool-specific logic.
Protected methodExecuteCore
Implement this method to perform tool-specific logic.
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.)
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.
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.
Protected methodIsEnabledCore
Override this method to control when the tool is enabled.
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.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Top
Version Information

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

Reference

Spotfire.Dxp.Application Namespace