Provides access to methods on the toolbox object. Note: the IGPToolbox interface has been superseded byIGPToolbox2. Please consider using the more recent version.
Product Availability
Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.
When To Use
The IGPToolbox interface provides access to methods for creating new tools, opening tools, checking existence of tools, as well discovering the names of tools in a given toolbox.
Members
| Description | ||
|---|---|---|
 |
Alias | The alias of the toolbox, used when referencing a tool: name_alias. |
 |
AlterAlias | Changes the alias of the toolbox. |
|
AlterHelpInfo | Sets the help (CHM) file and help context identifier containing help for this toolbox. |
|
CanCreateTool | Returns whether or not a new tool can be created in the toolbox. |
|
CreateTool | Creates a new tool in the toolbox. |
|
HelpContext | The context identifier of the topic within the help file for this toolbox. |
|
HelpFile | The name of the (CHM) file containing help information for this toolbox. |
|
IsDeleted | Indicates if the toolbox has been deleted. |
|
OpenTool | Returns a specific tool (by name) within the toolbox. |
|
PathName | The path name to the toolbox. |
|
ToolNames | An enumeration of all the geoprocessing tool name objects contained within the toolbox. |
|
Tools | An enumeration of all the geoprocessing tools contained within the toolbox. |
Remarks
A toolbox is a persistent entity that can contain toolsets and geoprocessing tools. It takes the form of a .tbx file on disk or a table in a geodatabase.
In a geodatabase, each toolbox must have a unique name. Note that this is different from a file system model, where two folders can contain toolboxes with the same local name within the folder.