ArcObjects Library Reference (SystemUI)

ToolHost CoClass

Use this class to host pure C++ tool implementations in a Toolbar.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

The ToolHost object is used when developing with the C++ API. C++ developers are unable to create new COM objects, so the CommandHost and ToolHost objects can be used to create custom commands and tools as follows:

Create your own class that inherits from CAoCommandBase or CAoToolBase and define the ICommand and/or ITool methods. CAoCommandBase and CAoToolBase are abstract classes which have all of the ICommand/ITool methods declared.
Create an instance of the Command/Tool and add it to a ToolbarControl using the AoToolbarAddCommand/AoToolbarAddTool function. The AoToolbarAddCommand/AoToolbarAddTool functions call ICommandHost::SetCommand which associates the custom Command/Tool with the instance of the CommandHost/ToolHost. Whenever an ICommand/ITool method on the CommandHost/ToolHost gets called it uses the pointer to forward the call to the custom Command/Tool.

The CAoCommandBase and CAoToolBase abstract classes and the AoToolbarAddCommand and AoToolbarAddTool functions are only intended to be used on UNIX and Linux platforms.

Supported Platforms

Windows, Solaris, Linux

Interfaces

Interfaces	Description
ICommand	Provides access to members that define a COM command.
ICommandHost	Provides access to the ICommandHost Interface.
ITool	Provides access to members that define a tool.