Feedback

  • Contents
 

II3IDTool Interface

Overview

Derived From:        IDispatch

Refined By:            II3IDTool2

Interface ID:          {412840AB-065F-4E74-AD18-602A0DE482E1}

II3IDTool provides an interface that wraps tool objects.  II3IDTool implements full support for external tools (i.e. tools created by developers) and has limited support for internal tools (i.e. tools created by Interaction Designer itself).

Methods

Commit

Commits a tool object so that it becomes available in Interaction Designer to handler developers.

RegisterForStepEvents

Registers an object to receive step events from Interaction Designer for this tool.

Properties

CategoryName

Returns the category name associated with this tool. The category name is localized.

Description

Returns the description associated for the tool. This string is localized.

Designer

Returns an Interaction Designer interface pointer.

ExitPaths

Returns a collection of the various exit paths defined for the tool.

HelpContext

Returns the Windows help context ID number of the help topic that discusses this tool.

HelpFile

Returns the name of the Windows help file associated with the tool.

II3IDToolAddOnInstance

Returns a COM interface pointer to the tool registered in Interaction Designer if the ToolSpecifier parameter to RegisterTool identified a COM object that implemented the II3IDToolAddOn interface.

IsCommitted

Indicates whether or not this tool has been committed (made available to handler developers in Interaction Designer).

IsExternal

Indicates whether or not this tool is an external tool. External tools are tools created by developers. Internal tools are tools created by Interaction Designer itself.

Label

Returns the label for the tool. This string is localized.

ModuleName

Returns the module name associated with the tool. The module name is not localized.

Name

Returns the name of the tool. The name is not localized.

ParameterDefinitions

Returns the parameter definitions (meta data) associated with the tool. Calls to this property to retrieve parameter definitions for an internal intiator or internal tool will fail, rather than return an empty collection.

RuntimeDLLName

Returns the runtime DLL name.

RuntimeFunctionName

Returns the runtime function name.

Version

Returns the registered version of this tool.

Visible

Indicates whether or not the tool is visible to the user.