com.esri.arcgis.carto
Interface IAnnotationFeature2

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnnotationFeature

public interface IAnnotationFeature2
extends Serializable

Provides access to members that control the annotation feature.

Remarks

The IAnnotationFeature interface is used for relating annotation features to other features or updating the graphic of the annotation. The Annotation property will accept any object implementing IGraphicElement. If a TextElement is used, you may reference an exiting TextSymbol stored in the SymbolCollection of the AnnotationFeatureClassExtension by using the ISymbolCollectionElement interface. It is highly recommended that you reference symbols in the SymbolCollection when storing TextElements in an annotation feature class. See the help for ISymbolCollectionElement for more details on this storage system.

The LinkedFeatureID property is used to indicate which feature the annotation is linked to for feature-linked annotation. If the feature is not linked, the property will be -1.

The AnnotationClassID property indicated which annotation class the annotation feature belogs to. An Annotation Feature Class may have have multiple Annotation Classes.

The Status property indicated whether or not the annotation feature is considered Placed or Unplaced. Unplaced annotation is not drawn by default.

After updating the either of these properties, the IFeature::Store method must be called.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IFeature, IFeatureCursor

Method Summary
 IElement getAnnotation()
          The annotation element for the feature.
 int getAnnotationClassID()
          Label Class ID.
 int getLinkedFeatureID()
          Feature ID.
 int getStatus()
          The current status of the annotation.
 void setAnnotation(IElement element)
          The annotation element for the feature.
 void setAnnotationClassID(int annotationClassID)
          Label Class ID.
 void setLinkedFeatureID(int fID)
          Feature ID.
 void setStatus(int status)
          The current status of the annotation.
 

Method Detail

getAnnotation

IElement getAnnotation()
                       throws IOException,
                              AutomationException
The annotation element for the feature.

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

setAnnotation

void setAnnotation(IElement element)
                   throws IOException,
                          AutomationException
The annotation element for the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLinkedFeatureID

void setLinkedFeatureID(int fID)
                        throws IOException,
                               AutomationException
Feature ID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLinkedFeatureID

int getLinkedFeatureID()
                       throws IOException,
                              AutomationException
Feature ID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAnnotationClassID

void setAnnotationClassID(int annotationClassID)
                          throws IOException,
                                 AutomationException
Label Class ID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAnnotationClassID

int getAnnotationClassID()
                         throws IOException,
                                AutomationException
Label Class ID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStatus

void setStatus(int status)
               throws IOException,
                      AutomationException
The current status of the annotation.

Product Availability

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

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

getStatus

int getStatus()
              throws IOException,
                     AutomationException
The current status of the annotation.

Product Availability

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

Returns:
A com.esri.arcgis.carto.esriAnnotationStatus constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.