com.esri.arcgis.geodatabase
Interface IFieldInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

FieldInfo

public interface IFieldInfo
extends Serializable

Provides access to properties that give extended information on the field.

Superseded By

IFieldInfo2

Remarks

The IFieldInfo interface allows you to set an alias for the field, set the number format if the field is numeric, set the visibility flag for the field, and return a string representation of a value in the field.

Product Availability

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

Method Summary

String	getAlias() The alias for the field.
String	getAsString(Object value) The string representation of a given value based on the current field information.
INumberFormat	getNumberFormat() The number format for the field (invalid if non-numeric field).
boolean	isVisible() Indicates if the field is visible.
void	setAlias(String aliasName) The alias for the field.
void	setNumberFormatByRef(INumberFormat format) The number format for the field (invalid if non-numeric field).
void	setVisible(boolean visible) Indicates if the field is visible.

Method Detail

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the field is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the field is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

String getAlias()
                throws IOException,
                       AutomationException

The alias for the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The aliasName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlias

void setAlias(String aliasName)
              throws IOException,
                     AutomationException

The alias for the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

aliasName - The aliasName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException

The number format for the field (invalid if non-numeric field).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFormatByRef

void setNumberFormatByRef(INumberFormat format)
                          throws IOException,
                                 AutomationException

The number format for the field (invalid if non-numeric field).

Product Availability

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

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsString

String getAsString(Object value)
                   throws IOException,
                          AutomationException

The string representation of a given value based on the current field information.

Product Availability

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

Parameters:

value - A Variant (in)

Returns:

The stringRep

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.