This document is archived and information here might be outdated.  Recommended version.


IGPToolbox Interface (ArcObjects .NET 10.7 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Geoprocessing > ESRI.ArcGIS.Geoprocessing > Interfaces > IG > IGPToolbox Interface
ArcGIS Developer Help

IGPToolbox Interface

Provides access to methods on the toolbox object. Note: the IGPToolbox interface has been superseded by IGPToolbox2. 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

Name Description
Read-only property Alias The alias of the toolbox, used when referencing a tool: name_alias.
Method AlterAlias Changes the alias of the toolbox.
Method AlterHelpInfo Sets the help (CHM) file and help context identifier containing help for this toolbox.
Method CanCreateTool Returns whether or not a new tool can be created in the toolbox.
Method CreateTool Creates a new tool in the toolbox.
Read-only property HelpContext The context identifier of the topic within the help file for this toolbox.
Read-only property HelpFile The name of the (CHM) file containing help information for this toolbox.
Read-only property IsDeleted Indicates if the toolbox has been deleted.
Method OpenTool Returns a specific tool (by name) within the toolbox.
Read-only property PathName The path name to the toolbox.
Read-only property ToolNames An enumeration of all the geoprocessing tool name objects contained within the toolbox.
Read-only property Tools An enumeration of all the geoprocessing tools contained within the toolbox.

Classes that implement IGPToolbox

Classes Description

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.