com.esri.arcgis.editor
Interface IEditAnnotationProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

Editor, IEditAnnotationPropertiesProxy

public interface IEditAnnotationProperties
extends Serializable

Provides access to members that control the annotation properties of an edit session.

Remarks

The IEditAnnotationProperties interface contains properties that modify the behavior of the Edit Annotation tool when editing existing Geodatabase annotation. In ArcMap these properties are exposed on the Editing options property page.

Product Availability

Available with ArcGIS Desktop.

Method Summary

ICallout	getLeaderSymbol() Symbol used to draw a leader.
ISymbol	getMultiWordSelectionSymbol() Symbol used to draw selected words in multiword annotation.
boolean	isShowAnnoHandles() Indicates whether the edit annotation tool will show the resize and rotate handles.
boolean	isUseFollowLineFeatureMode() Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to lines.
boolean	isUseFollowPolygonFeatureMode() Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to polygons.
void	setLeaderSymbolByRef(ICallout callout) Symbol used to draw a leader.
void	setMultiWordSelectionSymbolByRef(ISymbol symbol) Symbol used to draw selected words in multiword annotation.
void	setShowAnnoHandles(boolean flag) Indicates whether the edit annotation tool will show the resize and rotate handles.
void	setUseFollowLineFeatureMode(boolean flag) Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to lines.
void	setUseFollowPolygonFeatureMode(boolean flag) Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to polygons.

Method Detail

getLeaderSymbol

ICallout getLeaderSymbol()
                         throws IOException,
                                AutomationException

Symbol used to draw a leader.

Remarks

The LeaderSymbol property accepts objects that support ICallout. MarkerTextBackground objects cannot be used for the LeaderSymbol property. This property is an application-level setting and is used in ArcMap to add a leader to an annotation feature if the annotation feature's symbol does not have one defined.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeaderSymbolByRef

void setLeaderSymbolByRef(ICallout callout)
                          throws IOException,
                                 AutomationException

Symbol used to draw a leader.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowAnnoHandles

boolean isShowAnnoHandles()
                          throws IOException,
                                 AutomationException

Indicates whether the edit annotation tool will show the resize and rotate handles.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowAnnoHandles

void setShowAnnoHandles(boolean flag)
                        throws IOException,
                               AutomationException

Indicates whether the edit annotation tool will show the resize and rotate handles.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseFollowLineFeatureMode

boolean isUseFollowLineFeatureMode()
                                   throws IOException,
                                          AutomationException

Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to lines.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseFollowLineFeatureMode

void setUseFollowLineFeatureMode(boolean flag)
                                 throws IOException,
                                        AutomationException

Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to lines.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseFollowPolygonFeatureMode

boolean isUseFollowPolygonFeatureMode()
                                      throws IOException,
                                             AutomationException

Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to polygons.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseFollowPolygonFeatureMode

void setUseFollowPolygonFeatureMode(boolean flag)
                                    throws IOException,
                                           AutomationException

Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to polygons.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMultiWordSelectionSymbol

ISymbol getMultiWordSelectionSymbol()
                                    throws IOException,
                                           AutomationException

Symbol used to draw selected words in multiword annotation.

Remarks

This property controls the symbology used to define the selected paths (words) of a multiword annotation. Multipart annotation is stored as a series of paths allowing each path's position to be modified independently from the remaining paths of the annotation feature. You can check to see if an annotation feature contains multiple paths using the IMultipartTextElement::IsMultipart property.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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.

setMultiWordSelectionSymbolByRef

void setMultiWordSelectionSymbolByRef(ISymbol symbol)
                                      throws IOException,
                                             AutomationException

Symbol used to draw selected words in multiword annotation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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.