com.esri.arcgis.carto
Interface IAnnotateFeature2

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnnotateFeature, MaplexAnnotateFeature

public interface IAnnotateFeature2
extends Serializable

Provides access to members that control the labeling (annotation) of one feature.

Description

IAnnotateFeature2 provides access to method Label of the AnnotateFeature object. This object is used for low level generation of text elements at the feature level and is not intended to be used in a loop to generate text for an entire layer or map. IAnnotateFeature2 was added to extend the Label method to take a reference to an object implementing IOverposterProperties.

Product Availability

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

Method Summary

void	label(IOverposterProperties overposterProps, IAnnotateLayerProperties annoLayerProps, IFeature feature, IDisplay display, ISpatialReference pSpatialRef, IBarrierCollection barrierColl, IElement[] placedElement, IElement[] unplacedElement) Labels a feature based on the properties given.

Method Detail

label

void label(IOverposterProperties overposterProps,
           IAnnotateLayerProperties annoLayerProps,
           IFeature feature,
           IDisplay display,
           ISpatialReference pSpatialRef,
           IBarrierCollection barrierColl,
           IElement[] placedElement,
           IElement[] unplacedElement)
           throws IOException,
                  AutomationException

Labels a feature based on the properties given.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

overposterProps - A reference to a com.esri.arcgis.carto.IOverposterProperties (in)

annoLayerProps - A reference to a com.esri.arcgis.carto.IAnnotateLayerProperties (in)

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

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

pSpatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

barrierColl - A reference to a com.esri.arcgis.carto.IBarrierCollection (in)

placedElement - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

unplacedElement - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.