com.esri.arcgis.carto
Interface IAnnoClass

All Superinterfaces:

Serializable

All Known Subinterfaces:

IAnnotationClassExtension

All Known Implementing Classes:

AnnotationFeatureClassExtension

public interface IAnnoClass
extends Serializable

Provides access to members that control the annotation class.

When To Use

The IAnnoClass interface is mainly for getting properties of an annotation feature class. For example, use the IAnnoClass interface to view the reference scale and symbols associated with it. You can also draw individual annotation features using this interface.

Product Availability

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

Method Summary

void	draw(IAnnotationFeature annoFeature, IDisplay display, ISymbol symbol) Draws the given annotation feature.
IAnnotateLayerPropertiesCollection	getAnnoProperties() The labeling properties annotation classes.
int	getElementFieldIndex() The element field index.
IFeatureClass	getFeatureClass() The feature class.
int	getFeatureIDFieldIndex() The feature ID field index.
double	getReferenceScale() The reference scale.
int	getReferenceScaleUnits() The units of the reference scale.
ISymbol	getSymbol(int symbolID) The symbol associated with the given ID.
ISymbolCollection	getSymbolCollection() The symbol collection.
short	getVersion() The version of the annotation class.

Method Detail

getFeatureClass

IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException

The feature class.

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.

getAnnoProperties

IAnnotateLayerPropertiesCollection getAnnoProperties()
                                                     throws IOException,
                                                            AutomationException

The labeling properties annotation classes.

Remarks

Returns Nothing if no labeling properties set. This occurs when the annotation feature class is created by converting labels to annotation or when created as an annotation target containing graphics.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

ISymbol getSymbol(int symbolID)
                  throws IOException,
                         AutomationException

The symbol associated with the given ID.

Product Availability

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

Parameters:

symbolID - The symbolID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

double getReferenceScale()
                         throws IOException,
                                AutomationException

The reference scale.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The referenceScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScaleUnits

int getReferenceScaleUnits()
                           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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbolCollection

ISymbolCollection getSymbolCollection()
                                      throws IOException,
                                             AutomationException

The symbol collection.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

short getVersion()
                 throws IOException,
                        AutomationException

The version of the annotation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The version

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IAnnotationFeature annoFeature,
          IDisplay display,
          ISymbol symbol)
          throws IOException,
                 AutomationException

Draws the given annotation feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

annoFeature - A reference to a com.esri.arcgis.carto.IAnnotationFeature (in)

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

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementFieldIndex

int getElementFieldIndex()
                         throws IOException,
                                AutomationException

The element field index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The elementFieldIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureIDFieldIndex

int getFeatureIDFieldIndex()
                           throws IOException,
                                  AutomationException

The feature ID field index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The featureIDFieldIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.