com.esri.arcgis.carto
Interface IAnnotateLayerProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
LabelEngineLayerProperties, MaplexLabelEngineLayerProperties

public interface IAnnotateLayerProperties
extends Serializable

Provides access to members that work with the display of dynamic labels (text) for a feature layer.

Remarks

Each FeatureLayer can have one or more LabelEngineLayerProperties associated with it. These are exposed in the ArcMap user interface as label classes and a reference to these properties can be obtained from the IAnnotateLayerPropertiesCollection interface. IAnnotateLayerProperties is used to access and modify the labeling properties of a label class of a FeatureLayer.

When To Use

The IAnnotateLayerProperties interface maintains the labeling properties for a feature layer. You can use this interface to define the display of dynamic labels (text) along features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String esri_getClass()
          The class name.
 double getAnnotationMaximumScale()
          The maximum scale at which to display annotation.
 double getAnnotationMinimumScale()
          The minimum scale at which to display annotation.
 IEnvelope getExtent()
          The extent to perform labeling in.
 IFeatureLayer getFeatureLayer()
          The annotated feature class.
 IGraphicsContainer getGraphicsContainer()
          The output graphics container for placed labels.
 int getLabelWhichFeatures()
          The type of features labeled.
 int getPriority()
          Priority for labels of this feature class (0 is highest).
 String getWhereClause()
          SQL where clause that determines which features are labeled.
 boolean isAddUnplacedToGraphicsContainer()
          Indicates if overflow labels are put into a graphics container.
 boolean isCreateUnplacedElements()
          Indicates if unplaced elements are created.
 boolean isDisplayAnnotation()
          Indicates if the layer displays annotation.
 boolean isFeatureLinked()
          Indicates if the text is feature linked.
 boolean isUseOutput()
          Indicates if the output will be used.
 void setAddUnplacedToGraphicsContainer(boolean value)
          Indicates if overflow labels are put into a graphics container.
 void setAnnotationMaximumScale(double maxScale)
          The maximum scale at which to display annotation.
 void setAnnotationMinimumScale(double minScale)
          The minimum scale at which to display annotation.
 void setClass(String className)
          The class name.
 void setCreateUnplacedElements(boolean flag)
          Indicates if unplaced elements are created.
 void setDisplayAnnotation(boolean value)
          Indicates if the layer displays annotation.
 void setExtent(IEnvelope extent)
          The extent to perform labeling in.
 void setFeatureLayerByRef(IFeatureLayer featureLayer)
          The annotated feature class.
 void setFeatureLinked(boolean flag)
          Indicates if the text is feature linked.
 void setGraphicsContainerByRef(IGraphicsContainer graphicsContainer)
          The output graphics container for placed labels.
 void setLabelWhichFeatures(int type)
          The type of features labeled.
 void setPriority(int priority)
          Priority for labels of this feature class (0 is highest).
 void setUseOutput(boolean set)
          Indicates if the output will be used.
 void setWhereClause(String whereClause)
          SQL where clause that determines which features are labeled.
 

Method Detail

setUseOutput

void setUseOutput(boolean set)
                  throws IOException,
                         AutomationException
Indicates if the output will be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
set - The set (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseOutput

boolean isUseOutput()
                    throws IOException,
                           AutomationException
Indicates if the output will be used.

Description

UseOutput specifies whether or not to produce elements.

Remarks

This is useful when converting labels to graphics and some layers will not be creating graphics while they are still fed to the label engine to produce correct placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent to perform labeling in.

Description

Extent is the extent (IEnvelope ) that is used when LabelWhichFeatures is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExtent

void setExtent(IEnvelope extent)
               throws IOException,
                      AutomationException
The extent to perform labeling in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureLayer

IFeatureLayer getFeatureLayer()
                              throws IOException,
                                     AutomationException
The annotated feature class.

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.IFeatureLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureLayerByRef

void setFeatureLayerByRef(IFeatureLayer featureLayer)
                          throws IOException,
                                 AutomationException
The annotated feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
featureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClass

void setClass(String className)
              throws IOException,
                     AutomationException
The class name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
className - The className (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_getClass

String esri_getClass()
                     throws IOException,
                            AutomationException
The class name.

Product Availability

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

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

setLabelWhichFeatures

void setLabelWhichFeatures(int type)
                           throws IOException,
                                  AutomationException
The type of features labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
type - A com.esri.arcgis.carto.esriLabelWhichFeatures constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelWhichFeatures

int getLabelWhichFeatures()
                          throws IOException,
                                 AutomationException
The type of features labeled.

Description

LabelWhichFeatures specifies which features to label (all, selected or visible).

Remarks

This is useful when converting labels to graphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriLabelWhichFeatures constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCreateUnplacedElements

void setCreateUnplacedElements(boolean flag)
                               throws IOException,
                                      AutomationException
Indicates if unplaced elements are created.

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.

isCreateUnplacedElements

boolean isCreateUnplacedElements()
                                 throws IOException,
                                        AutomationException
Indicates if unplaced elements are created.

Description

CreateUnplacedElements specifies whether or not unplaced elements will be created.

Remarks

Unplaced elements are labels who don't fit without overlapping each other. This is useful when converting labels to graphics.

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.

getAnnotationMinimumScale

double getAnnotationMinimumScale()
                                 throws IOException,
                                        AutomationException
The minimum scale at which to display annotation.

Description

AnnotationMinimumScale is the minimum scale at which labels will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAnnotationMinimumScale

void setAnnotationMinimumScale(double minScale)
                               throws IOException,
                                      AutomationException
The minimum scale at which to display annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
minScale - The minScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationMaximumScale

double getAnnotationMaximumScale()
                                 throws IOException,
                                        AutomationException
The maximum scale at which to display annotation.

Description

AnnotationMaximumScale is the maximum scale at which labels will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAnnotationMaximumScale

void setAnnotationMaximumScale(double maxScale)
                               throws IOException,
                                      AutomationException
The maximum scale at which to display annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
maxScale - The maxScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureLinked

void setFeatureLinked(boolean flag)
                      throws IOException,
                             AutomationException
Indicates if the text is feature linked.

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.

isFeatureLinked

boolean isFeatureLinked()
                        throws IOException,
                               AutomationException
Indicates if the text is feature linked.

Description

FeatureLinked FeatureLinked specifies whether or not labels will be created with a link to the feature attributes.

Remarks

This is useful when converting labels to annotation.

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.

setPriority

void setPriority(int priority)
                 throws IOException,
                        AutomationException
Priority for labels of this feature class (0 is highest).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

int getPriority()
                throws IOException,
                       AutomationException
Priority for labels of this feature class (0 is highest).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isDisplayAnnotation

boolean isDisplayAnnotation()
                            throws IOException,
                                   AutomationException
Indicates if the layer displays annotation.

Description

DisplayAnnotation specifies whether or not the labels in this set will be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDisplayAnnotation

void setDisplayAnnotation(boolean value)
                          throws IOException,
                                 AutomationException
Indicates if the layer displays annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException
SQL where clause that determines which features are labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
whereClause - The whereClause (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException
SQL where clause that determines which features are labeled.

Description

WhereClause is an SQL statement that determines which features are to be labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setGraphicsContainerByRef

void setGraphicsContainerByRef(IGraphicsContainer graphicsContainer)
                               throws IOException,
                                      AutomationException
The output graphics container for placed labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
graphicsContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGraphicsContainer

IGraphicsContainer getGraphicsContainer()
                                        throws IOException,
                                               AutomationException
The output graphics container for placed labels.

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.IGraphicsContainer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAddUnplacedToGraphicsContainer

boolean isAddUnplacedToGraphicsContainer()
                                         throws IOException,
                                                AutomationException
Indicates if overflow labels are put into a graphics container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAddUnplacedToGraphicsContainer

void setAddUnplacedToGraphicsContainer(boolean value)
                                       throws IOException,
                                              AutomationException
Indicates if overflow labels are put into a graphics container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.