ShareToolTContext Class TIBCO Spotfire 7.6 API Reference
This is the base class for creating share tools. It provides the ability to perform asynchronous prompting.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.ApplicationTool
    Spotfire.Dxp.ApplicationToolTContext
      Spotfire.Dxp.ApplicationShareToolTContext
        Spotfire.Dxp.Application.ExtensionCustomShareToolTContext

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 ShareToolTContext 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.
(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(TContext)
Throws NotSupportedException. Use ExecuteCore(TContext, ShareToolExecutionContext) instead.
(Overrides ToolTContextExecuteCore(TContext).)
Protected methodExecuteCore(TContext, ShareToolExecutionContext)
Executes the tool with the specified contexts
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.
(Inherited from ToolTContext.)
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.)
Top
Version Information

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

Reference