com.esri.arcgis.editor
Class IEditAnnotationPropertiesProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.editor.IEditAnnotationPropertiesProxy

All Implemented Interfaces:

IEditAnnotationProperties, Externalizable, Serializable

public class IEditAnnotationPropertiesProxy
extends com.esri.arcgis.interop.Dispatch
implements IEditAnnotationProperties, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IEditAnnotationPropertiesProxy()
	IEditAnnotationPropertiesProxy(Object obj)
protected	IEditAnnotationPropertiesProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IEditAnnotationPropertiesProxy

public IEditAnnotationPropertiesProxy()

IEditAnnotationPropertiesProxy

public IEditAnnotationPropertiesProxy(Object obj)
                               throws IOException

Throws:

IOException

IEditAnnotationPropertiesProxy

protected IEditAnnotationPropertiesProxy(Object obj,
                                         String iid)
                                  throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getLeaderSymbol

public 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

Specified by:

getLeaderSymbol in interface IEditAnnotationProperties

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

public void setLeaderSymbolByRef(ICallout callout)
                          throws IOException,
                                 AutomationException

Symbol used to draw a leader.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setLeaderSymbolByRef in interface IEditAnnotationProperties

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

public 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

Specified by:

isShowAnnoHandles in interface IEditAnnotationProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowAnnoHandles

public 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

Specified by:

setShowAnnoHandles in interface IEditAnnotationProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseFollowLineFeatureMode

public 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

Specified by:

isUseFollowLineFeatureMode in interface IEditAnnotationProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseFollowLineFeatureMode

public 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

Specified by:

setUseFollowLineFeatureMode in interface IEditAnnotationProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseFollowPolygonFeatureMode

public 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

Specified by:

isUseFollowPolygonFeatureMode in interface IEditAnnotationProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseFollowPolygonFeatureMode

public 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

Specified by:

setUseFollowPolygonFeatureMode in interface IEditAnnotationProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMultiWordSelectionSymbol

public 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

Specified by:

getMultiWordSelectionSymbol in interface IEditAnnotationProperties

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

public 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

Specified by:

setMultiWordSelectionSymbolByRef in interface IEditAnnotationProperties

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.