com.esri.arcgis.geoprocessing
Interface IGPToolbox

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGPToolboxProxy

public interface IGPToolbox
extends Serializable

Provides access to methods on the toolbox object.

Superseded By

IGPToolbox2

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.

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.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void alterAlias(String newAlias)
          Changes the alias of the toolbox.
 void alterHelpInfo(String file, int context)
          Sets the help (CHM) file and help context identifier containing help for this toolbox.
 boolean canCreateTool()
          Returns whether or not a new tool can be created in the toolbox.
 IGPTool createTool(int type, String name, String displayName, String description, String toolCategory, IGPToolExtension toolExtension)
          Creates a new tool in the toolbox.
 String getAlias()
          The alias of the toolbox, used when referencing a tool: name_alias.
 int getHelpContext()
          The context identifier of the topic within the help file for this toolbox.
 String getHelpFile()
          The name of the (CHM) file containing help information for this toolbox.
 String getPathName()
          The path name to the toolbox.
 IEnumGPToolName getToolNames()
          An enumeration of all the geoprocessing tool name objects contained within the toolbox.
 IEnumGPTool getTools()
          An enumeration of all the geoprocessing tools contained within the toolbox.
 boolean isDeleted()
          Indicates if the toolbox has been deleted.
 IGPTool openTool(String name)
          Returns a specific tool (by name) within the toolbox.
 

Method Detail

getPathName

String getPathName()
                   throws IOException,
                          AutomationException
The path name to the toolbox.

Product Availability

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

Supported Platforms

Windows

Returns:
The path
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlias

String getAlias()
                throws IOException,
                       AutomationException
The alias of the toolbox, used when referencing a tool: name_alias.

Product Availability

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

Supported Platforms

Windows

Returns:
The alias
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToolNames

IEnumGPToolName getToolNames()
                             throws IOException,
                                    AutomationException
An enumeration of all the geoprocessing tool name objects contained within the toolbox.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumGPToolName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTools

IEnumGPTool getTools()
                     throws IOException,
                            AutomationException
An enumeration of all the geoprocessing tools contained within the toolbox.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumGPTool
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openTool

IGPTool openTool(String name)
                 throws IOException,
                        AutomationException
Returns a specific tool (by name) within the toolbox.

Product Availability

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

Supported Platforms

Windows

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPTool
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDeleted

boolean isDeleted()
                  throws IOException,
                         AutomationException
Indicates if the toolbox has been deleted.

Product Availability

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

Supported Platforms

Windows

Returns:
The deleted
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCreateTool

boolean canCreateTool()
                      throws IOException,
                             AutomationException
Returns whether or not a new tool can be created in the toolbox.

Product Availability

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

Supported Platforms

Windows

Returns:
The canCreateTool
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createTool

IGPTool createTool(int type,
                   String name,
                   String displayName,
                   String description,
                   String toolCategory,
                   IGPToolExtension toolExtension)
                   throws IOException,
                          AutomationException
Creates a new tool in the toolbox.

Product Availability

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

Supported Platforms

Windows

Parameters:
type - A com.esri.arcgis.geoprocessing.esriGPToolType constant (in)
name - The name (in)
displayName - The displayName (in)
description - The description (in)
toolCategory - The toolCategory (in)
toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPTool
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterAlias

void alterAlias(String newAlias)
                throws IOException,
                       AutomationException
Changes the alias of the toolbox.

Product Availability

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

Supported Platforms

Windows

Parameters:
newAlias - The newAlias (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpFile

String getHelpFile()
                   throws IOException,
                          AutomationException
The name of the (CHM) file containing help information for this toolbox.

Product Availability

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

Supported Platforms

Windows

Returns:
The file
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpContext

int getHelpContext()
                   throws IOException,
                          AutomationException
The context identifier of the topic within the help file for this toolbox.

Product Availability

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

Supported Platforms

Windows

Returns:
The context
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterHelpInfo

void alterHelpInfo(String file,
                   int context)
                   throws IOException,
                          AutomationException
Sets the help (CHM) file and help context identifier containing help for this toolbox.

Product Availability

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

Supported Platforms

Windows

Parameters:
file - The file (in)
context - The context (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.