com.esri.arcgis.carto
Interface IAnnoClassAdmin

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnnotationFeatureClassExtension

public interface IAnnoClassAdmin
extends Serializable

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

Superseded By

IAnnoClassAdmin3

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 property 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.

See IAnnoClassAdmin2, and IAnnoClassAdmin3 for more properties of the AnnotationFeatureClassExtension.

The following example shows how you can use the IAnnoClassAdmin interface to turn of the auto-creation of annotation when features are created in the linked feature class.

When To Use

The IAnnoClassAdmin 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

See Also:
IAnnotationFeature

Method Summary
 boolean isAutoCreate()
          Indicates if an annotation is to be automatically created when a feature is created.
 void setAnnoProperties(IAnnotateLayerPropertiesCollection rhs1)
          The labeling properties annotation class.
 void setAutoCreate(boolean flag)
          Indicates if an annotation is to be automatically created when a feature is created.
 void setReferenceScale(double rhs1)
          The reference scale.
 void setReferenceScaleUnits(int rhs1)
          The units of the reference scale.
 void setSymbolCollectionByRef(ISymbolCollection rhs1)
          The symbol collection.
 void updateProperties()
          Updates the property set.
 

Method Detail

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.

setAutoCreate

void setAutoCreate(boolean flag)
                   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:
flag - The flag (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.

Remarks

The reference scale describes the scale at which the annotation text is displayed at the font size specified. As you zoom out, the text will get smaller, and as you zoom in, the text will get larger.

The reference scale should always be in the same units as the horizontal coordinate system (geographic or projected) of the annotation class.

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.