com.esri.arcgis.geoprocessing
Interface IGPParameterEdit

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGPParameterEdit2, IGPParameterEdit3
All Known Implementing Classes:
GPParameter, MdParameter

public interface IGPParameterEdit
extends Serializable

Provides access to the editable properties/methods of a geoprocessing parameter object.

Superseded By

IGPParameterEdit3

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.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addDependency(String name)
          Adds the name of a parameter that this geoprocessing parameter object is dependent on.
 void setAltered(boolean rhs1)
          Indicates whether the parameter value has been explicitly set (by the user).
 void setCategory(String rhs1)
          Category of the geoprocessing parameter.
 void setChoiceListByRef(IGPChoiceList rhs1)
          The choice list object of the geoprocessing parameter.
 void setControlCLSID(IUID rhs1)
          The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.
 void setDataTypeByRef(IGPDataType rhs1)
          Data type of the geoprocessing parameter.
 void setDefaultEnvironmentName(String rhs1)
          The name of the environment value to use as the default value for the geoprocessing parameter.
 void setDirection(int rhs1)
          Direction of the geoprocessing parameter.
 void setDisplayName(String rhs1)
          Display name of the geoprocessing parameter.
 void setDisplayOrder(int rhs1)
          The display order of the geoprocessing parameter.
 void setDomainByRef(IGPDomain rhs1)
          Domain of the geoprocessing parameter.
 void setEnabled(boolean rhs1)
          Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.
 void setHasBeenValidated(boolean rhs1)
          Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).
 void setName(String rhs1)
          Name of the geoprocessing parameter.
 void setParameterDependencies(IEnumBSTR rhs1)
          Enumeration of parameter names the geoprocessing parameter is dependent on.
 void setParameterType(int rhs1)
          Type of the geoprocessing parameter.
 void setValueByRef(IGPValue rhs1)
          The current value object of the geoprocessing parameter.
 

Method Detail

setName

void setName(String rhs1)
             throws IOException,
                    AutomationException
Name of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayName

void setDisplayName(String rhs1)
                    throws IOException,
                           AutomationException
Display name of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int rhs1)
                  throws IOException,
                         AutomationException
Direction of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataTypeByRef

void setDataTypeByRef(IGPDataType rhs1)
                      throws IOException,
                             AutomationException
Data type of the geoprocessing parameter.

Product Availability

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

Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParameterType

void setParameterType(int rhs1)
                      throws IOException,
                             AutomationException
Type of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - A com.esri.arcgis.geoprocessing.esriGPParameterType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParameterDependencies

void setParameterDependencies(IEnumBSTR rhs1)
                              throws IOException,
                                     AutomationException
Enumeration of parameter names the geoprocessing parameter is dependent on.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IEnumBSTR (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDomainByRef

void setDomainByRef(IGPDomain rhs1)
                    throws IOException,
                           AutomationException
Domain of the geoprocessing parameter.

Product Availability

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

Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnabled

void setEnabled(boolean rhs1)
                throws IOException,
                       AutomationException
Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValueByRef

void setValueByRef(IGPValue rhs1)
                   throws IOException,
                          AutomationException
The current value object of the geoprocessing parameter.

Product Availability

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

Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setControlCLSID

void setControlCLSID(IUID rhs1)
                     throws IOException,
                            AutomationException
The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultEnvironmentName

void setDefaultEnvironmentName(String rhs1)
                               throws IOException,
                                      AutomationException
The name of the environment value to use as the default value for the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayOrder

void setDisplayOrder(int rhs1)
                     throws IOException,
                            AutomationException
The display order of the geoprocessing parameter.

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAltered

void setAltered(boolean rhs1)
                throws IOException,
                       AutomationException
Indicates whether the parameter value has been explicitly set (by the user).

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHasBeenValidated

void setHasBeenValidated(boolean rhs1)
                         throws IOException,
                                AutomationException
Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).

Product Availability

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

Supported Platforms

Windows

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addDependency

void addDependency(String name)
                   throws IOException,
                          AutomationException
Adds the name of a parameter that this geoprocessing parameter object is dependent on.

Product Availability

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

Supported Platforms

Windows

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(String rhs1)
                 throws IOException,
                        AutomationException
Category of the geoprocessing parameter.

Product Availability

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

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setChoiceListByRef

void setChoiceListByRef(IGPChoiceList rhs1)
                        throws IOException,
                               AutomationException
The choice list object of the geoprocessing parameter.

Product Availability

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

Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IGPChoiceList (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.