This is the base class for creating share tools. It provides the ability
to perform asynchronous prompting.
Inheritance Hierarchy
Spotfire.Dxp.Application.Tool
Spotfire.Dxp.Application.Tool< TContext>
Spotfire.Dxp.Application.ShareTool<TContext>
Spotfire.Dxp.Application.Extension.CustomShareTool<TContext>
Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
public abstract class ShareTool<TContext> : Tool<TContext>, IShareTool where TContext : class
Type Parameters
- TContext
- The context that the share tool operates on.
The ShareTool< TContext> 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.
(Inherited from Tool<TContext>.) |
| ExecuteAndPrompt |
Executes the tool for the specified context.
If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from Tool<TContext>.) |
 | ExecuteAndPromptCore |
Implement this method to perform tool-specific logic.
(Inherited from Tool<TContext>.) |
| ExecuteCore(TContext) | Throws NotSupportedException.
Use ExecuteCore(TContext, ShareToolExecutionContext) instead.
(Overrides Tool<TContext>.ExecuteCore(TContext).) |
| ExecuteCore(TContext, ShareToolExecutionContext) |
Executes the tool with the specified contexts
|
| 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.
(Inherited from Tool<TContext>.) |
| 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.
(Inherited from Tool<TContext>.) |
| IsEnabledCore |
Override this method to control when the tool is enabled.
(Inherited from Tool<TContext>.) |
| 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.
(Inherited from Tool<TContext>.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
Version Information
Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also
See Also