CustomShareTool<TContext> Class

Spotfire 14.5 API Reference
This is the base class when creating a custom share tool.
Inheritance Hierarchy

System.Object
  Spotfire.Dxp.Application.Tool
    Spotfire.Dxp.Application.Tool<TContext>
      Spotfire.Dxp.Application.ShareTool<TContext>
        Spotfire.Dxp.Application.Extension.CustomShareTool<TContext>

Namespace:  Spotfire.Dxp.Application.Extension
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 67.0.20819.4186 (67.0.20819.4186)
Syntax

C#
public abstract class CustomShareTool<TContext> : ShareTool<TContext>
where TContext : class

Type Parameters

TContext
The type that this tool operates on, that is, the context of the tool. Currently, the following types are supported:

Page - Available from the context menu for the Page tabs

Any of the built-in visuals (for example ScatterPlot) - Available from the context menu for the visual.

BookmarkContext - Available from the context menu in the bookmark panel.

The CustomShareTool<TContext> type exposes the following members.

Constructors

  NameDescription
Protected methodCustomShareTool<TContext>(String)
Initializes a new instance of the CustomShareTool<TContext> class.
Protected methodCustomShareTool<TContext>(String, Image) Obsolete.
Initializes a new instance of the CustomShareTool<TContext> class.
Protected methodCustomShareTool<TContext>(String, ExtensionIcon, LicensedFunction)
Initializes a new instance of the CustomShareTool<TContext> class.
Protected methodCustomShareTool<TContext>(String, Image, LicensedFunction) Obsolete.
Initializes a new instance of the CustomShareTool<TContext> class.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecute
Executes the tool for the specified context. If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from Tool<TContext>.)
Public methodExecuteAndPrompt
Executes the tool for the specified context. If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from Tool<TContext>.)
Protected methodExecuteAndPromptCore
Implement this method to perform tool-specific logic.
(Inherited from Tool<TContext>.)
Protected methodExecuteCore(TContext)
Throws NotSupportedException. Use ExecuteCore(TContext, ShareToolExecutionContext) instead.
(Inherited from ShareTool<TContext>.)
Protected methodExecuteCore(TContext, ShareToolExecutionContext)
Executes the tool with the specified contexts
(Inherited from ShareTool<TContext>.)
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.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetMenuTextCore
Gets the menu text for the tool.
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 Tool<TContext>.)
Public methodGetToolbarIdCore
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.
(Inherited from Tool.)
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 Tool<TContext>.)
Protected methodIsEnabledCore
Override this method to control when the tool is enabled.
(Inherited from Tool<TContext>.)
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 Tool<TContext>.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Supported in: 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference