|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGPParameterEdit
Provides access to the editable properties/methods of a geoprocessing parameter object.
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.
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 |
---|
void setName(String rhs1) throws IOException, AutomationException
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDisplayName(String rhs1) throws IOException, AutomationException
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDirection(int rhs1) throws IOException, AutomationException
rhs1
- A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDataTypeByRef(IGPDataType rhs1) throws IOException, AutomationException
rhs1
- A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setParameterType(int rhs1) throws IOException, AutomationException
rhs1
- A com.esri.arcgis.geoprocessing.esriGPParameterType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setParameterDependencies(IEnumBSTR rhs1) throws IOException, AutomationException
rhs1
- A reference to a com.esri.arcgis.system.IEnumBSTR (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDomainByRef(IGPDomain rhs1) throws IOException, AutomationException
rhs1
- A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEnabled(boolean rhs1) throws IOException, AutomationException
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setValueByRef(IGPValue rhs1) throws IOException, AutomationException
rhs1
- A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setControlCLSID(IUID rhs1) throws IOException, AutomationException
rhs1
- A reference to a com.esri.arcgis.system.IUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDefaultEnvironmentName(String rhs1) throws IOException, AutomationException
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDisplayOrder(int rhs1) throws IOException, AutomationException
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setAltered(boolean rhs1) throws IOException, AutomationException
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHasBeenValidated(boolean rhs1) throws IOException, AutomationException
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addDependency(String name) throws IOException, AutomationException
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCategory(String rhs1) throws IOException, AutomationException
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setChoiceListByRef(IGPChoiceList rhs1) throws IOException, AutomationException
rhs1
- A reference to a com.esri.arcgis.geodatabase.IGPChoiceList (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |