com.esri.arcgis.geodatabase
Interface IFieldInfo3

All Superinterfaces:
Serializable
All Known Implementing Classes:
FieldInfo

public interface IFieldInfo3
extends Serializable

Provides access to properties that give extended information on 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 isHighlight()
          Indicates how the field should be presented.
 boolean isReadonly()
          Indicates how the field should be presented.
 boolean isValueAsRatio()
          Indicates if the field value should be the ratio of itself.
 boolean isVisible()
          Indicates if the field is visible.
 void setAlias(String aliasName)
          The alias for the field.
 void setHighlight(boolean highlight)
          Indicates how the field should be presented.
 void setNumberFormatByRef(INumberFormat format)
          The number format for the field (invalid if non-numeric field).
 void setReadonly(boolean readonlyField)
          Indicates how the field should be presented.
 void setValueAsRatio(boolean ratio)
          Indicates if the field value should be the ratio of itself.
 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.

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.

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.

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.

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.

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.

isValueAsRatio

boolean isValueAsRatio()
                       throws IOException,
                              AutomationException
Indicates if the field value should be the ratio of itself.

Product Availability

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

Returns:
The ratio
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValueAsRatio

void setValueAsRatio(boolean ratio)
                     throws IOException,
                            AutomationException
Indicates if the field value should be the ratio of itself.

Product Availability

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

Parameters:
ratio - The ratio (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHighlight

boolean isHighlight()
                    throws IOException,
                           AutomationException
Indicates how the field should be presented.

Description

This property determines if the field is highlighted in clients that choose to implement it.

Remarks

Setting the value to true highlights the field name in yellow within the ArcMap identify and attributes window.

In the Arcmap UI this is set in the layer field properties dialog.

Product Availability

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

Returns:
The highlight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHighlight

void setHighlight(boolean highlight)
                  throws IOException,
                         AutomationException
Indicates how the field should be presented.

Product Availability

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

Parameters:
highlight - The highlight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReadonly

boolean isReadonly()
                   throws IOException,
                          AutomationException
Indicates how the field should be presented.

Description

This property determines if the field is read only in clients that choose to implement it.

Remarks

Setting the value to true will make the field read only in clients such as the ArcMap editor attribute window. This property only applies to clients that choose to implement it.

In the Arcmap UI this is set in the layer field properties dialog.

Product Availability

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

Returns:
The readonlyField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReadonly

void setReadonly(boolean readonlyField)
                 throws IOException,
                        AutomationException
Indicates how the field should be presented.

Product Availability

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

Parameters:
readonlyField - The readonlyField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.