com.esri.arcgis.carto
Interface IAnnotateMap

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnnotateMap, MaplexAnnotateMap

public interface IAnnotateMap
extends Serializable

Provides access to members that control the Labeling (annotation) of a map.

Superseded By

IAnnotateMap2

Description

IAnnotateMap has been superseded by IAnnotateMap2. Use IAnnotateMap2.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILabelEngineLayerProperties

Method Summary
 void draw(IDisplay display, IAnnotateMapProperties annoMapCmdProps, IMap map, ITrackCancel trackCancel)
          Draws labels for feature layers based on the properties given.
 IUID getFeatureLayerPropertiesID()
          The UID that is expected for feature layer properties.
 String getName()
          Name of the engine that will create the labels ( annotation).
 void label(IAnnotateMapProperties annoMapCmdProps, IMap map, ITrackCancel trackCancel)
          Labels feature layers based on the properties given.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the engine that will create the labels ( annotation).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFeatureLayerPropertiesID

IUID getFeatureLayerPropertiesID()
                                 throws IOException,
                                        AutomationException
The UID that is expected for feature layer properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

label

void label(IAnnotateMapProperties annoMapCmdProps,
           IMap map,
           ITrackCancel trackCancel)
           throws IOException,
                  AutomationException
Labels feature layers based on the properties given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
annoMapCmdProps - A reference to a com.esri.arcgis.carto.IAnnotateMapProperties (in)
map - A reference to a com.esri.arcgis.carto.IMap (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IAnnotateMapProperties annoMapCmdProps,
          IMap map,
          ITrackCancel trackCancel)
          throws IOException,
                 AutomationException
Draws labels for feature layers based on the properties given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
annoMapCmdProps - A reference to a com.esri.arcgis.carto.IAnnotateMapProperties (in)
map - A reference to a com.esri.arcgis.carto.IMap (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.