com.esri.arcgis.geoprocessing
Interface IDEToolbox2

All Superinterfaces:

IDEToolbox, Serializable

All Known Implementing Classes:

DEToolbox

public interface IDEToolbox2
extends IDEToolbox, Serializable

Provides access to properties/methods of a toolbox data element object.

Product Availability

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

Method Summary

String	getDisplayName() The display name of the toolbox.
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.
void	setDisplayName(String displayName) The display name of the toolbox.
void	setHelpContext(int context) The context identifier of the topic within the help file for this toolbox.
void	setHelpFile(String file) The name of the (CHM) file containing help information for this toolbox.

Methods inherited from interface com.esri.arcgis.geoprocessing.IDEToolbox

getAlias, setAlias

Method Detail

getDisplayName

String getDisplayName()
                      throws IOException,
                             AutomationException

The display name of the toolbox.

Product Availability

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

Returns:

The displayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

void setDisplayName(String displayName)
                    throws IOException,
                           AutomationException

The display name of the toolbox.

Product Availability

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

Parameters:

displayName - The displayName (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.

Returns:

The file

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpFile

void setHelpFile(String file)
                 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.

Parameters:

file - The file (in)

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.

Returns:

The context

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpContext

void setHelpContext(int context)
                    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.

Parameters:

context - The context (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.