com.esri.arcgis.geoprocessing
Interface IGPToolboxEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

GxToolbox, IGPToolboxEventsAdapter, MdProcess

public interface IGPToolboxEvents
extends EventListener, Serializable

Provides access to toolbox events.

Product Availability

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

Method Summary

void	onToolAdded(IGPToolboxEventsOnToolAddedEvent theEvent) Called when a tool is added to the toolbox.
void	onToolboxDeleted(IGPToolboxEventsOnToolboxDeletedEvent theEvent) Called when the toolbox is deleted.
void	onToolboxRenamed(IGPToolboxEventsOnToolboxRenamedEvent theEvent) Called when the toolbox is renamed.
void	onToolDeleted(IGPToolboxEventsOnToolDeletedEvent theEvent) Called when a tool is deleted from the toolbox.
void	onToolStateChanged(IGPToolboxEventsOnToolStateChangedEvent theEvent) Called when a tool's state has changed.
void	onToolStored(IGPToolboxEventsOnToolStoredEvent theEvent) Called when a tool is stored to the toolbox.

Method Detail

onToolboxDeleted

void onToolboxDeleted(IGPToolboxEventsOnToolboxDeletedEvent theEvent)
                      throws IOException,
                             AutomationException

Called when the toolbox is deleted.

Product Availability

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

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolboxRenamed

void onToolboxRenamed(IGPToolboxEventsOnToolboxRenamedEvent theEvent)
                      throws IOException,
                             AutomationException

Called when the toolbox is renamed.

Product Availability

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

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolAdded

void onToolAdded(IGPToolboxEventsOnToolAddedEvent theEvent)
                 throws IOException,
                        AutomationException

Called when a tool is added to the toolbox.

Product Availability

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

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolDeleted

void onToolDeleted(IGPToolboxEventsOnToolDeletedEvent theEvent)
                   throws IOException,
                          AutomationException

Called when a tool is deleted from the toolbox.

Product Availability

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

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolStored

void onToolStored(IGPToolboxEventsOnToolStoredEvent theEvent)
                  throws IOException,
                         AutomationException

Called when a tool is stored to the toolbox.

Product Availability

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

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onToolStateChanged

void onToolStateChanged(IGPToolboxEventsOnToolStateChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Called when a tool's state has changed.

Product Availability

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

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.