com.esri.arcgis.carto
Interface IStandardAnnotateMap

All Superinterfaces:

Serializable

All Known Implementing Classes:

IStandardAnnotateMapProxy

public interface IStandardAnnotateMap
extends Serializable

Provides access to Esri-default Annotate Map properties.

Remarks

This interface is not supported for customization and may be removed at a future release.

Product Availability

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

Method Summary

ILabelCache	getLabelCache() The label cache used by the map.
boolean	isRecordLabelsToCache() Indicates if labels are recorded to the cache whenever the map needs labeling.
void	setRecordLabelsToCache(boolean flag) Indicates if labels are recorded to the cache whenever the map needs labeling.

Method Detail

isRecordLabelsToCache

boolean isRecordLabelsToCache()
                              throws IOException,
                                     AutomationException

Indicates if labels are recorded to the cache whenever the map needs labeling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecordLabelsToCache

void setRecordLabelsToCache(boolean flag)
                            throws IOException,
                                   AutomationException

Indicates if labels are recorded to the cache whenever the map needs labeling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelCache

ILabelCache getLabelCache()
                          throws IOException,
                                 AutomationException

The label cache used by the map.

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.ILabelCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.