com.esri.arcgis.editor
Interface IAnnotationEditExtension

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnnotationEditExtension

public interface IAnnotationEditExtension
extends Serializable

Provides access to members that control annotation feature editing.

Remarks

Use IEditor::FindExtension to access the AnnotationEditExtension and its interfaces.

Product Availability

Available with ArcGIS Desktop.

Method Summary

IEnumAnnotationConstructor	getAnnotationConstructors() The annotation constructors for creating new annotations.
ITextSymbol	getConstructionSymbol() The symbol to be used for newly created annotation features.
int	getConstructionSymbolID() The symbol id of newly created annotation features.
String	getConstructionText() The current text that will be used to construct the annotation.
IAnnotationConstructor	getCurrentConstructor() The currently selected annotation constructor.
int	getLinkedFeatureID() The linked feature id for the newly created annotation feature.
boolean	isAnnotationTarget() Indicates if an annotation feature class is the current editor target.
void	setConstructionSymbolID(int text) The symbol id of newly created annotation features.
void	setConstructionText(String text) The current text that will be used to construct the annotation.
void	setCurrentConstructorByRef(IAnnotationConstructor constructor) The currently selected annotation constructor.
void	setLinkedFeatureID(int featureID) The linked feature id for the newly created annotation feature.

Method Detail

getAnnotationConstructors

IEnumAnnotationConstructor getAnnotationConstructors()
                                                     throws IOException,
                                                            AutomationException

The annotation constructors for creating new annotations.

Remarks

Returns the current annotation constructors under the component category 'ESRI Annotation Constructors', returning them in an IEnumAnnotationConstructor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.editor.IEnumAnnotationConstructor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentConstructor

IAnnotationConstructor getCurrentConstructor()
                                             throws IOException,
                                                    AutomationException

The currently selected annotation constructor.

Remarks

CurrentConstructor returns an IAnnotationConstructor representing the AnnotationExitExtension's current annotation constructor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.editor.IAnnotationConstructor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentConstructorByRef

void setCurrentConstructorByRef(IAnnotationConstructor constructor)
                                throws IOException,
                                       AutomationException

The currently selected annotation constructor.

Remarks

Use this property to check or change the editor's current annotation construction method. When the editor's current task is 'Create New Feature' and the IEditLayers::CurrentLayer is an annotation layer, IAnnotationEditExtension::CurrentConstructor determines the geometry of the edit sketch used to complete the new annotation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

constructor - A reference to a com.esri.arcgis.editor.IAnnotationConstructor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAnnotationTarget

boolean isAnnotationTarget()
                           throws IOException,
                                  AutomationException

Indicates if an annotation feature class is the current editor target.

Remarks

Determines if the editor's target layer is an annotation feature class. This could also be determined by querying the GeometryType of the target layer's feature class. This property returns True for both 8.3 annotation feature classes and annotation updated or created in 9.0.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isAnnotation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConstructionText

String getConstructionText()
                           throws IOException,
                                  AutomationException

The current text that will be used to construct the annotation.

Remarks

ConstructionText determines the text string used for constructing new annotation features. ConstructionText may contain a value containing line break characters to construct stacked text. To set the ConstructionText to be multi-line you can use your development environment's carriage return character in the string you set to the ConstructionText property. If the ConstructionText value is an empty string, the AnnotationEditExtension will automatically use the default string "Text".

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstructionText

void setConstructionText(String text)
                         throws IOException,
                                AutomationException

The current text that will be used to construct the annotation.

Remarks

Use this property to determine the text string used during the creation of new annotation features. Changing this property does not impact the text of existing annotation features.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConstructionSymbolID

int getConstructionSymbolID()
                            throws IOException,
                                   AutomationException

The symbol id of newly created annotation features.

Remarks

Use this property to control the symbol used for constructing new annotation features. When setting the value of ConstructionSymbolID You should check the target annotation feature class' symbol collection to ensure that the ID exists; if it does not exist an error will be returned.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstructionSymbolID

void setConstructionSymbolID(int text)
                             throws IOException,
                                    AutomationException

The symbol id of newly created annotation features.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConstructionSymbol

ITextSymbol getConstructionSymbol()
                                  throws IOException,
                                         AutomationException

The symbol to be used for newly created annotation features.

Remarks

Returns the current text symbol from the symbol collection of the current target annotation feature class. Use the symbol returned when creating feedback for a custom annotation constructor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkedFeatureID

int getLinkedFeatureID()
                       throws IOException,
                              AutomationException

The linked feature id for the newly created annotation feature.

Remarks

This property allows you to set the FeatureID value for newly-constructed annotation. The value determines the feature in the origin class it is linked to if the annotation feature class is feature-linked.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The featureID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinkedFeatureID

void setLinkedFeatureID(int featureID)
                        throws IOException,
                               AutomationException

The linked feature id for the newly created annotation feature.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

featureID - The featureID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.