This is the base class when creating a custom export tool.
Inheritance Hierarchy
Spotfire.Dxp.ApplicationTool
Spotfire.Dxp.ApplicationToolDocument
Spotfire.Dxp.Application.ToolsExportTool
Spotfire.Dxp.Application.ExtensionCustomExportTool
Namespace: Spotfire.Dxp.Application.Extension
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 30.0.10915.3380 (30.0.10915.3380)
Syntax
C#
public abstract class CustomExportTool : ExportTool
The CustomExportTool type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CustomExportTool(String) | Initializes a new instance of the CustomExportTool class.
|
| CustomExportTool(String, Image) | Initializes a new instance of the CustomExportTool class.
|
| CustomExportTool(String, Image, LicensedFunction) | Initializes a new instance of the CustomExportTool class.
|
Methods
| Name | Description | |
|---|---|---|
 | Execute |
Executes the tool for the specified context.
If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from ToolTContext.) |
| ExecuteAndPrompt |
Executes the tool for the specified context.
If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from ToolTContext.) |
| ExecuteAndPromptCore |
Implement this method to perform tool-specific logic.
(Inherited from ToolTContext.) |
| ExecuteCore(Document) |
Implement this method to perform tool-specific logic.
(Inherited from ExportTool.) |
 | ExecuteCore(Document, ExportResult) | Implement this method to perform tool specific logic.
This method will always be executed as a top-level progress operation.
(Inherited from ExportTool.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetMenuTextCore |
Gets the menu text for the tool.
|
| 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 ToolTContext.) |
| 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 ToolTContext.) |
| IsEnabledCore |
Override this method to control when the tool is enabled.
(Inherited from ToolTContext.) |
| 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 ToolTContext.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
Version Information
See Also