com.esri.arcgis.geodatabase
Interface IFieldEdit

All Superinterfaces:
IField, Serializable
All Known Subinterfaces:
IFieldEdit2
All Known Implementing Classes:
Field

public interface IFieldEdit
extends IField, Serializable

Provides access to members that edit the field properties.

Superseded By

IFieldEdit2

Description

The IFieldEdit interface is used when creating new fields. You should not use it to modify fields, for that purpose use IClassSchemaEdit. In general, when modifying fields, the restrictions that apply in ArcCatalog also apply in ArcObjects; for example, you cannot change the name or type of a field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void setAliasName(String rhs1)
          The alias name of the field.
 void setDefaultValue(Object rhs1)
          The default value of the field.
 void setDomainByRef(IDomain rhs1)
          The default domain of the field.
 void setDomainFixed(boolean rhs1)
          Indicates if the field's domain cannot be modified.
 void setEditable(boolean rhs1)
          Indicates if the field can be edited.
 void setGeometryDefByRef(IGeometryDef rhs1)
          The geometry definition if IsGeometry is TRUE.
 void setIsNullable(boolean rhs1)
          Indicates if field values can be null.
 void setLength(int rhs1)
          The maximum length, in bytes, for field values.
 void setName(String rhs1)
          The name of the field.
 void setPrecision(int rhs1)
          The precision for field values.
 void setRequired(boolean rhs1)
          Indicates if the field is required.
 void setScale(int rhs1)
          The scale for field values.
 void setType(int rhs1)
          The type for the field.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IField
checkValue, getAliasName, getDefaultValue, getDomain, getGeometryDef, getLength, getName, getPrecision, getScale, getType, getVarType, isDomainFixed, isEditable, isNullable, isRequired
 

Method Detail

setName

void setName(String rhs1)
             throws IOException,
                    AutomationException
The name of the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAliasName

void setAliasName(String rhs1)
                  throws IOException,
                         AutomationException
The alias name of the field.

Remarks

This is only supported on fields from object classes and feature classes that are registered with a personal, File or ArcSDE geodatabase.

This is not supported for shapefiles, coverages, or other data sources.

You can register a table within the geodatabase to become an object class by right-clicking on the table in ArcCatalog and clicking on "Register with Geodatabase".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDomainByRef

void setDomainByRef(IDomain rhs1)
                    throws IOException,
                           AutomationException
The default domain of the field.

Remarks

This is only supported on fields from object classes and feature classes that are registered with the geodatabase; Personal, File or ArcSDE.

This is not supported for shapefiles, coverages, or other data sources.

You can register a table within the geodatabase to become an object class by right-clicking on the table in ArcCatalog and clicking on "Register with Geodatabase".

The IFieldEdit::Domain method is used to associate domains when creating new fields. You should not use it to modify existing fields, for that purpose use IClassSchemaEdit::AlterDomain or ISubtypes::Domain.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultValue

void setDefaultValue(Object rhs1)
                     throws IOException,
                            AutomationException
The default value of the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setType

void setType(int rhs1)
             throws IOException,
                    AutomationException
The type for the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A com.esri.arcgis.geodatabase.esriFieldType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLength

void setLength(int rhs1)
               throws IOException,
                      AutomationException
The maximum length, in bytes, for field values.

Remarks

The length property of a field has meaning only for esriFieldTypeString fields. The length property for all other field types is not important and will be ignored if specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPrecision

void setPrecision(int rhs1)
                  throws IOException,
                         AutomationException
The precision for field values.

Description

Precision is the number of digits in a number. For example, the number 56.78 has a precision of 4. Precision is only valid for fields that are numeric.

Remarks

Precision is always returned as 0 from personal or File geodatabase fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setScale

void setScale(int rhs1)
              throws IOException,
                     AutomationException
The scale for field values.

Description

Scale is the number of digits to the right of the decimal point in a number. For example, the number 56.78 has a scale of 2. Scale applies only to fields that are double.

Remarks

Precision is always returned as 0 from personal or File geodatabase fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setIsNullable

void setIsNullable(boolean rhs1)
                   throws IOException,
                          AutomationException
Indicates if field values can be null.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setGeometryDefByRef

void setGeometryDefByRef(IGeometryDef rhs1)
                         throws IOException,
                                AutomationException
The geometry definition if IsGeometry is TRUE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDomainFixed

void setDomainFixed(boolean rhs1)
                    throws IOException,
                           AutomationException
Indicates if the field's domain cannot be modified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setRequired

void setRequired(boolean rhs1)
                 throws IOException,
                        AutomationException
Indicates if the field is required.

Remarks

The Required property only applies to changes to modifying the schema of a Field's properties or blocking it from being deleted. It has no impact on the ability to update or add\delete the values within the field. Also, setting the Required field property to be True will block the user from deleting the field through the GUI, as well as through ArcObjects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setEditable

void setEditable(boolean rhs1)
                 throws IOException,
                        AutomationException
Indicates if the field can be edited. This should always be set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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