com.esri.arcgis.framework
Interface IArcToolboxTool

All Superinterfaces:

Serializable

All Known Implementing Classes:

IArcToolboxToolProxy

public interface IArcToolboxTool
extends Serializable

Provides access to members that control the Toolbox tools.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	execute(Object inputData) Run the tool.
Picture	getBitmap() The bitmap that is used as the icon for this tool.
int	getHelpContextID() The help context ID associated with this tool.
String	getHelpFile() The name of the help file associated with this tool.
String	getMessage() The description for this tool.
int	getModality() The modality for the tool.
String	getName() The name of this tool.
String	getTreeviewLocation() The location of the tool in the treeview.
void	onCreate(Object hook) Occurs when this tool is created.
void	setModality(int dialogModality) The modality for the tool.

Method Detail

setModality

void setModality(int dialogModality)
                 throws IOException,
                        AutomationException

The modality for the tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

dialogModality - A com.esri.arcgis.framework.esriATModality constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModality

int getModality()
                throws IOException,
                       AutomationException

The modality for the tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.framework.esriATModality constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The name of this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

String getMessage()
                  throws IOException,
                         AutomationException

The description for this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The message

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 help file associated with this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

int getHelpContextID()
                     throws IOException,
                            AutomationException

The help context ID associated with this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The helpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBitmap

Picture getBitmap()
                  throws IOException,
                         AutomationException

The bitmap that is used as the icon for this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTreeviewLocation

String getTreeviewLocation()
                           throws IOException,
                                  AutomationException

The location of the tool in the treeview.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The treeviewLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

void onCreate(Object hook)
              throws IOException,
                     AutomationException

Occurs when this tool is created.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

hook - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

void execute(Object inputData)
             throws IOException,
                    AutomationException

Run the tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

inputData - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.