com.esri.arcgis.geodatabase
Interface IXYEvent2FieldsProperties

All Superinterfaces:

IXYEventProperties, Serializable

All Known Implementing Classes:

XYEvent2FieldsProperties

public interface IXYEvent2FieldsProperties
extends IXYEventProperties, Serializable

Provides access to members that define the fields needed to create an XY event layer. A minimum of two fields (X and Y) are required.

Remarks

The IXYEvent2FieldsProperties interface has properties for specifying the x field name, the y field name and the z field name. The x and y field name properties are required and must always return valid fields names, while the z field name is optional. The number 2 appears in the interface name because two of the three fields are required.

This information is used when creating a new XY feature class and can be returned from an existing XY feature class.

The fields must have numeric data types. For example, if your coordinates are stored in degrees, minutes and seconds, you need to convert them to decimal degrees and store them in numeric fields. These numeric fields can then be used to create an XY feature class.

Product Availability

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

Method Summary

String	getXFieldName() The name of the X field.
String	getYFieldName() The name of the Y field.
String	getZFieldName() The name of the Z field (optional).
void	setXFieldName(String fieldName) The name of the X field.
void	setYFieldName(String fieldName) The name of the Y field.
void	setZFieldName(String fieldName) The name of the Z field (optional).

Method Detail

setXFieldName

void setXFieldName(String fieldName)
                   throws IOException,
                          AutomationException

The name of the X field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXFieldName

String getXFieldName()
                     throws IOException,
                            AutomationException

The name of the X field.

Remarks

This field specified with this property must have a numeric data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYFieldName

void setYFieldName(String fieldName)
                   throws IOException,
                          AutomationException

The name of the Y field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYFieldName

String getYFieldName()
                     throws IOException,
                            AutomationException

The name of the Y field.

Remarks

This field specified with this property must have a numeric data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFieldName

void setZFieldName(String fieldName)
                   throws IOException,
                          AutomationException

The name of the Z field (optional).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZFieldName

String getZFieldName()
                     throws IOException,
                            AutomationException

The name of the Z field (optional).

Remarks

This field specified with this property must have a numeric data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.