com.esri.arcgis.carto
Interface IAnnotationClassExtension

All Superinterfaces:
IAnnoClass, Serializable
All Known Implementing Classes:
AnnotationFeatureClassExtension

public interface IAnnotationClassExtension
extends IAnnoClass, Serializable

Provides access to members that control the annotation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getAnnotationClassIDFieldIndex()
          The label class ID field index.
 IDisplay getDisplay()
          The display.
 IFeatureClass getLinkedFeatureClass()
          The feature class to which the annotation class is feature linked.
 IOverposterProperties getOverposterProperties()
          The overposter properties.
 int getStatusFieldIndex()
          The status field index.
 boolean isAllowSymbolOverrides()
          Indicates if an annotation may override a symbol property even though it references the symbol collection.
 boolean isAutoCreate()
          Indicates if an annotation is to be automatically created when a feature is created.
 boolean isRequireSymbolID()
          Indicates if an annotation must belong to a symbol in the symbol collection.
 boolean isUpdateOnShapeChange()
          Indicates if an annotation is to be automatically recreated when a feature's shape is changed.
 void synchronizeAttributes(ITextElement pTextElement, IAnnotationFeature pAnnoFeature)
          Sync the attributes.
 
Methods inherited from interface com.esri.arcgis.carto.IAnnoClass
draw, getAnnoProperties, getElementFieldIndex, getFeatureClass, getFeatureIDFieldIndex, getReferenceScale, getReferenceScaleUnits, getSymbol, getSymbolCollection, getVersion
 

Method Detail

getDisplay

IDisplay getDisplay()
                    throws IOException,
                           AutomationException
The display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.IDisplay
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

synchronizeAttributes

void synchronizeAttributes(ITextElement pTextElement,
                           IAnnotationFeature pAnnoFeature)
                           throws IOException,
                                  AutomationException
Sync the attributes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pTextElement - A reference to a com.esri.arcgis.carto.ITextElement (in)
pAnnoFeature - A reference to a com.esri.arcgis.carto.IAnnotationFeature (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationClassIDFieldIndex

int getAnnotationClassIDFieldIndex()
                                   throws IOException,
                                          AutomationException
The label class ID field index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getStatusFieldIndex

int getStatusFieldIndex()
                        throws IOException,
                               AutomationException
The status field index.

Product Availability

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

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

isUpdateOnShapeChange

boolean isUpdateOnShapeChange()
                              throws IOException,
                                     AutomationException
Indicates if an annotation is to be automatically recreated when a feature's shape is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isAutoCreate

boolean isAutoCreate()
                     throws IOException,
                            AutomationException
Indicates if an annotation is to be automatically created when a feature is created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isRequireSymbolID

boolean isRequireSymbolID()
                          throws IOException,
                                 AutomationException
Indicates if an annotation must belong to a symbol in the symbol collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isAllowSymbolOverrides

boolean isAllowSymbolOverrides()
                               throws IOException,
                                      AutomationException
Indicates if an annotation may override a symbol property even though it references the symbol collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOverposterProperties

IOverposterProperties getOverposterProperties()
                                              throws IOException,
                                                     AutomationException
The overposter properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.IOverposterProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLinkedFeatureClass

IFeatureClass getLinkedFeatureClass()
                                    throws IOException,
                                           AutomationException
The feature class to which the annotation class is feature linked.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.