com.esri.arcgis.carto
Interface IAnnotationFeature

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnnotationFeature

public interface IAnnotationFeature
extends Serializable

Provides access to members that control the annotation feature.

Superseded By

IAnnotationFeature2

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.

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

When To Use

The IAnnotationFeature interface maintains information about an annotation feature.

Example:

// Assume we have an IAnnotationFeature reference (pAnnoFeature);
IAnnotationFeature pAnnoFeature = null;
IElement pElement = pAnnoFeature.getAnnotation();
 if(pElement instanceof ITextElement){

        ITextElement pTextElement = new ITextElementProxy(pElement);

        pTextElement.setText("foo");

        pAnnoFeature.setAnnotation(pElement);

        IFeature pFeature = new IFeatureProxy(pAnnoFeature);

        pFeature.store();

      }

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 getLinkedFeatureID()
          Feature ID.
 void setAnnotation(IElement element)
          The annotation element for the feature.
 void setLinkedFeatureID(int fID)
          Feature ID.
 

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.