com.esri.arcgis.geoprocessing
Interface IGPFieldInfo2

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPFieldInfo

public interface IGPFieldInfo2
extends Serializable

Provides access to the properties/methods of a geoprocessing field info object.

Product Availability

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

Method Summary

String	getJoinDelimiter(int index) Returns the join delimiter of the specified field in the field info object.
int	getMergeRule(int index) Returns the merge rule of the specified field in the field info object.
void	getTextPos(int index, int[] start, int[] end) Returns the start and end text positions.
void	setJoinDelimiter(int index, String delimiter) Sets the join delimiter of the specified field in the field info object.
void	setMergeRule(int index, int merge) Sets the merge rule of the specified field in the field info object.
void	setTextPos(int index, int start, int end) Sets the start and end text positions.

Method Detail

getMergeRule

int getMergeRule(int index)
                 throws IOException,
                        AutomationException

Returns the merge rule of the specified field in the field info object.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMergeRule

void setMergeRule(int index,
                  int merge)
                  throws IOException,
                         AutomationException

Sets the merge rule of the specified field in the field info object.

Product Availability

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

Parameters:

index - The index (in)

merge - A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

String getJoinDelimiter(int index)
                        throws IOException,
                               AutomationException

Returns the join delimiter of the specified field in the field info object.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The delimiter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinDelimiter

void setJoinDelimiter(int index,
                      String delimiter)
                      throws IOException,
                             AutomationException

Sets the join delimiter of the specified field in the field info object.

Product Availability

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

Parameters:

index - The index (in)

delimiter - The delimiter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextPos

void getTextPos(int index,
                int[] start,
                int[] end)
                throws IOException,
                       AutomationException

Returns the start and end text positions.

Product Availability

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

Parameters:

index - The index (in)

start - The start (out: use single element array)

end - The end (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextPos

void setTextPos(int index,
                int start,
                int end)
                throws IOException,
                       AutomationException

Sets the start and end text positions.

Product Availability

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

Parameters:

index - The index (in)

start - The start (in)

end - The end (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.