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