com.esri.arcgis.carto
Interface IAnnoClassAdmin3

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnnotationFeatureClassExtension

public interface IAnnoClassAdmin3
extends Serializable

Provides access to members that control the annotation class admin interface.

Remarks

In a versioned geodatabase, these properties apply to all versions and are not versioned. After creating an annotation feature class, modifying these properties may cause problems with the drawing and selection of annotation features. Adding new symbols to the SymbolCollection or changing the AutoCreate, UpdateOnShapeChange, OverposterProperties, and RequireSymbolID properties are the only recommend modifications. Deleting or modifying symbols in the SymbolCollection requires updating all annotation features whose elements reference the group symbol. When adding new symbols to the SymbolCollection use the AddSymbol method of ISymbolCollection2 , which will automatically assign a unique ID to the symbol. As with any schema related change, it is recommended that an exclusive schema lock be obtained before calling the UpdateProperties method.

IAnnoClassAdmin3 was added to include the AllowSymbolOverrides, OverposterProperties, and RequireSymbolID properties for an AnnotationFeatureClassExtension object.

The AllowSymbolOverrides property indicates if an annotation may override a symbol property even though it references the symbol collection. If set to false, only the AnchorPoint, Background, and TextPath of the text symbol can be modified. Modifications of these properties should be performed using IGroupSymbolElement or IGroupSymbolElement2. This property is best employed in conjunction with RequireSymbolID and is used to limit the properties of an annotation feature that can be edited for either database efficiency of institutional reasons.

The OverposterProperties property indicates which label engine is to be used by the annotation feature class to generate/update feature-linked annotation.

The RequireSymbolID property indicates if annotation features are required to reference a symbol in the symbol collection. Referencing a symbol in the symbol collection is the most efficient way to store annotation features. If a symbol does not reference a symbol in the symbol collection, the text symbol is inefficiently stored inline with the feature in the feature’s blob field. Setting this property ensures that features reference a symbol in the symbol collection and are therefore efficiently stored. To avoid separating annotation features from their referenced symbol, modify the properties of each annotation element using ISymbolCollectionElement. This interfaces allows access to the properties of an annotation feature class that can be overridden. Please note that setting AllowSymbolOverrides to False greatly reduces the number of properties that can be overridden. See above for more details.

When To Use

The IAnnoClassAdmin3 interface is used to modify the feature class extension properties of an annotation feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void setAllowSymbolOverrides(boolean rhs1)
          Indicates if an annotation may override a symbol property even though it references the symbol collection.
 void setAnnoProperties(IAnnotateLayerPropertiesCollection rhs1)
          The labeling properties annotation class.
 void setAutoCreate(boolean rhs1)
          Indicates if an annotation is to be automatically created when a feature is created.
 void setOverposterProperties(IOverposterProperties rhs1)
          The overposter properties.
 void setReferenceScale(double rhs1)
          The reference scale.
 void setReferenceScaleUnits(int rhs1)
          The units of the reference scale.
 void setRequireSymbolID(boolean rhs1)
          Indicates an annotation must belong to a symbol in the symbol collection.
 void setSymbolCollectionByRef(ISymbolCollection rhs1)
          The symbol collection.
 void setUpdateOnShapeChange(boolean rhs1)
          Indicates if an annotation is to be automatically recreated when a feature's shape is changed.
 void updateFieldIndexes()
          Updates the indexes of the fields that expose the annotation properties.
 void updateProperties()
          Updates the property set.
 

Method Detail

setAutoCreate

void setAutoCreate(boolean rhs1)
                   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

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

setAnnoProperties

void setAnnoProperties(IAnnotateLayerPropertiesCollection rhs1)
                       throws IOException,
                              AutomationException
The labeling properties annotation class.

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.carto.IAnnotateLayerPropertiesCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceScale

void setReferenceScale(double rhs1)
                       throws IOException,
                              AutomationException
The reference scale.

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.

setReferenceScaleUnits

void setReferenceScaleUnits(int rhs1)
                            throws IOException,
                                   AutomationException
The units of the reference scale.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSymbolCollectionByRef

void setSymbolCollectionByRef(ISymbolCollection rhs1)
                              throws IOException,
                                     AutomationException
The symbol collection.

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.display.ISymbolCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateProperties

void updateProperties()
                      throws IOException,
                             AutomationException
Updates the property set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUpdateOnShapeChange

void setUpdateOnShapeChange(boolean rhs1)
                            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

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

setRequireSymbolID

void setRequireSymbolID(boolean rhs1)
                        throws IOException,
                               AutomationException
Indicates 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

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

setAllowSymbolOverrides

void setAllowSymbolOverrides(boolean rhs1)
                             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

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

setOverposterProperties

void setOverposterProperties(IOverposterProperties rhs1)
                             throws IOException,
                                    AutomationException
The overposter properties.

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.carto.IOverposterProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateFieldIndexes

void updateFieldIndexes()
                        throws IOException,
                               AutomationException
Updates the indexes of the fields that expose the annotation properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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