com.esri.arcgis.geoprocessing
Interface IGPValueTableType

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPMultiValueType, GPRasterCalculatorExpressionType, GPSAExtractValuesType, GPSAFuzzyFunctionType, GPSATopoFeaturesType, GPSAWeightedOverlayTableType, GPSAWeightedSumType, GPValueTableType

public interface IGPValueTableType
extends Serializable

Provides access to the properties/methods of the value table data type.

When To Use

For an extended code sample refer to the Parameter DataType—Lists section of the Building Geoprocessing Functions technical document.

Product Availability

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

Method Summary

void	addDataType(IGPDataType pDataType, String displayName, int width, IUID cLSID) Adds the given data type to the value table data type.
IUID	getControlCLSID(int index) The class identifier (CLSID) of the ActiveX control for the data type at the given index in the value table data type.
int	getCount() The number of data types/columns of the value table data type.
IGPDataType	getDataType(int index) The data type object of the given column index.
String	getDisplayName(int index) The display name of the given column of the value table data type.
int	getWidth(int index) The width of the given column of the value table data type.
void	removeDataType(int index) Removes the data type/column at the given index from the value table data type.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of data types/columns of the value table data type.

Product Availability

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

Supported Platforms

Windows

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

IGPDataType getDataType(int index)
                        throws IOException,
                               AutomationException

The data type object of the given column index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPDataType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth(int index)
             throws IOException,
                    AutomationException

The width of the given column of the value table data type.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

String getDisplayName(int index)
                      throws IOException,
                             AutomationException

The display name of the given column of the value table data type.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pDisplayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDataType

void addDataType(IGPDataType pDataType,
                 String displayName,
                 int width,
                 IUID cLSID)
                 throws IOException,
                        AutomationException

Adds the given data type to the value table data type.

Product Availability

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

Supported Platforms

Windows

Parameters:

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

displayName - The displayName (in)

width - The width (in)

cLSID - 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.

removeDataType

void removeDataType(int index)
                    throws IOException,
                           AutomationException

Removes the data type/column at the given index from the value table data type.

Product Availability

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

Supported Platforms

Windows

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getControlCLSID

IUID getControlCLSID(int index)
                     throws IOException,
                            AutomationException

The class identifier (CLSID) of the ActiveX control for the data type at the given index in the value table data type.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.