com.esri.arcgis.display
Interface IFieldOverrides

All Superinterfaces:

Serializable

All Known Implementing Classes:

RepresentationRule

public interface IFieldOverrides
extends Serializable

Provides access to a collection of field overrides.

Remarks

Use IFieldOverrides interface to manage the different field overrides set for specific graphical attribute of basic symbol, geometric effect and marker placement that are present within a representation rule.

Add method can be used to add a new field override given an Index of a specific graphical attribute within a GraphicAttributes collection and the Name of the field into which the attribute overrides are written to.

Reset method is used to reset all field overrides present on a representation rule. Next method is used to retrieve the individual field override. Use IFieldOverride interface to access properties present for a field override. Note: Reset method has to be called prior to calling Next method.

Note: FieldOverrides can be explicitly made only when the Field type matches with the graphical attribute type.

Index - esriGraphicAttributeType	Supported esriFieldType (IField::Type)
0 - esriAttributeTypeBoolean	esriFieldTypeInteger, esriFieldTypeSmallInteger, esriFieldTypeString
1 - esriAttributeTypeInteger	esriFieldTypeInteger, esriFieldTypeSmallInteger
2 - esriAttributeTypeEnum	esriFieldTypeInteger, esriFieldTypeSmallInteger
3 - esriAttributeTypeDouble	esriFieldTypeSingle, esriFieldTypeDouble
4 - esriAttributeTypeSize	esriFieldTypeSingle, esriFieldTypeDouble
5 - esriAttributeTypeText	esriFieldTypeString
6 - esriAttributeTypeColor	esriFieldTypeBlob
7 - esriAttributeTypeMarker	esriFieldTypeBlob
8 - esriAttributeTypeDash	esriFieldTypeString

Product Availability

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

Method Summary

void	add(IGraphicAttributes attributes, int graphicAttributeIndex, String fieldName) Creates an explicit override with field content.
IFieldOverride	next() Accesses the next field override in the collection.
void	reset() Resets the override collection, before calling Next.

Method Detail

add

void add(IGraphicAttributes attributes,
         int graphicAttributeIndex,
         String fieldName)
         throws IOException,
                AutomationException

Creates an explicit override with field content. To erase an existing field override, pass in blank field name.

Product Availability

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

Parameters:

attributes - A reference to a com.esri.arcgis.display.IGraphicAttributes (in)

graphicAttributeIndex - The graphicAttributeIndex (in)

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the override collection, before calling Next.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

IFieldOverride next()
                    throws IOException,
                           AutomationException

Accesses the next field override in the collection.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IFieldOverride

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.