ArcObjects Library Reference (Geoprocessing)  

IGPParameterEdit Interface

Provides access to the editable properties/methods of a geoprocessing parameter object. Note: the IGPParameterEdit interface has been superseded byIGPParameterEdit3. Please consider using the more recent version.

Product Availability

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

When To Use

The IGPParameterEdit interface is used to define properties of each input and output parameter to a geoprocessing tool. A complete example to create a geoprocessing function tool is available here: Building Geoprocessing Function Tools.

Members

Description
Method AddDependency Adds the name of a parameter that this geoprocessing parameter object is dependent on.
Write-only property Altered Indicates whether the parameter value has been explicitly set (by the user).
Write-only property Category Category of the geoprocessing parameter.
Write-only property ChoiceList The choice list object of the geoprocessing parameter.
Write-only property ControlCLSID The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.
Write-only property DataType Data type of the geoprocessing parameter.
Write-only property DefaultEnvironmentName The name of the environment value to use as the default value for the geoprocessing parameter.
Write-only property Direction Direction of the geoprocessing parameter.
Write-only property DisplayName Display name of the geoprocessing parameter.
Write-only property DisplayOrder The display order of the geoprocessing parameter.
Write-only property Domain Domain of the geoprocessing parameter.
Write-only property Enabled Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.
Write-only property HasBeenValidated Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).
Write-only property Name Name of the geoprocessing parameter.
Write-only property ParameterDependencies Enumeration of parameter names the geoprocessing parameter is dependent on.
Write-only property ParameterType Type of the geoprocessing parameter.
Write-only property Value The current value object of the geoprocessing parameter.

CoClasses that implement IGPParameterEdit

CoClasses and Classes Description
GPParameter Geoprocessing Parameter object.
MdParameter Model parameter object that references a model variable or contains a value object.

.NET Samples

Import signposts (Code Files: ImportDynamapSignsFunction ImportMultiNetSignsFunction ImportNavStreetsSignsFunction) |