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


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

IGPTool Interface

Provides access to methods on a geoprocessing tool object.

Product Availability

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

When To Use

The GPTool object contains properties that provide access to a tool's name, its help file, and license status. The arguments to the tool are made up of an array of parameter (IGPParameter) or value (IGPValue) objects . The array of parameter objects is created by using the parameterInfo property.

The GPTool object also contains methods for validating the parameters and executing the tool.

Members

Name Description
Method CanAlter Returns whether or not the properties of the tool can be modified.
Method CanEditSource Returns whether or not the source (i.e., definition) of the tool can be modified.
Read/write property Description The description of the tool.
Read-only property DialogCLSID The class identifier of the custom dialog to use for this tool.
Read/write property DisplayName The display name of the tool.
Method EditProperties Presents a modal dialog to edit the tool's properties.
Method Execute Executes the tool with the given set of values.
Method GetRenderer Returns the renderer associated with the specified parameter.
Read/write property HelpContext The context identifier of the topic within the help file for this tool.
Read/write property HelpFile Name of the (CHM) file containing help information for this tool.
Read-only property IsDeleted Indicates if the tool has been deleted.
Method IsLicensed Returns whether the tool is licensed to be executed.
Method IsLicensedForProduct Returns whether the tool is part of the current product.
Method IsValid Returns whether the tool is capable of being executed/edited.
Read/write property Name The name of the tool.
Read-only property ParameterInfo The set of parameters required to execute the tool.
Read-only property PathName The path of the tool object.
Read/write property RelativePaths Indicates if path names are stored relative to the tool/toolbox.
Method Store Stores the current state of the tool to the toolbox.
Read-only property Toolbox The toolbox of the tool.
Read/write property ToolCategory The tool category.
Read-only property ToolType The type of tool.
Method Validate Validates the given set of values.

Classes that implement IGPTool

Classes Description

Remarks

There are three types of geoprocessing tools: a GPModelTool, a GPScriptTool, and a GPFunctionTool. Geoprocessing tools will take a set of inputs and generate one or more outputs. A generic GPTool object is obtained from a toolbox, with OpenTool method of IGPToolbox interface. 

.NET Samples

Geoprocessing events listener