CustomExportTool Methods TIBCO Spotfire 7.6 API Reference

The CustomExportTool type exposes the following members.

Methods

  Name Description
Public method Execute
Executes the tool for the specified context. If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from ToolTContext.)
Public method ExecuteAndPrompt
Executes the tool for the specified context. If IsEnabled(TContext) returns false, this method does nothing.
(Inherited from ToolTContext.)
Protected method ExecuteAndPromptCore
Implement this method to perform tool-specific logic.
(Inherited from ToolTContext.)
Protected method ExecuteCore(Document)
Implement this method to perform tool-specific logic.
(Inherited from ExportTool.)
Protected method Code example 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.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected method GetMenuTextCore
Gets the menu text for the tool.
Protected method 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.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method 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.)
Protected method IsEnabledCore
Override this method to control when the tool is enabled.
(Inherited from ToolTContext.)
Protected method 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.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Top
See Also

Reference