com.esri.arcgis.carto
Interface ILabelEngineLayerProperties2

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

public interface ILabelEngineLayerProperties2
extends Serializable

Provides access to some of the main properties for labeling features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

ILabelEngineLayerProperties2::OverposterLayerProperties is the generic way to get to the labeling properties for a layer. Depending on if the layer is being labeled with the ESRI Maplex Labeling Engine or the ESRI Standard Labeling Engine, this property will return either a MaplexOverposterLayerProperties object or a BasicOverposterLayerProperties object.


Method Summary
 int getAnnotationClassID()
          The ID of the annotation class.
 IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
          The overposter properties, which specify how labels are placed relative to features.
 String getExpression()
          The VBScript or JScript expression that evaluates and formats the label.
 IAnnotationExpressionEngine getExpressionParser()
          The object that interprets the expression.
 double getOffset()
          The offset between the label and the feature.
 IOverposterLayerProperties getOverposterLayerProperties()
          The overposter properties, which specify how labels are placed relative to features.
 ITextSymbol getSymbol()
          The text symbol used to draw the label.
 int getSymbolID()
          The ID of the group symbol used to draw the label.
 boolean isExpressionSimple()
          Indicates if the expression is simple.
 void setAnnotationClassID(int annotationClassID)
          The ID of the annotation class.
 void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
          The overposter properties, which specify how labels are placed relative to features.
 void setExpression(String expression)
          The VBScript or JScript expression that evaluates and formats the label.
 void setExpressionParserByRef(IAnnotationExpressionEngine engine)
          The object that interprets the expression.
 void setIsExpressionSimple(boolean simpleExpression)
          Indicates if the expression is simple.
 void setOffset(double offset)
          The offset between the label and the feature.
 void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
          The overposter properties, which specify how labels are placed relative to features.
 void setSymbolByRef(ITextSymbol textSymbol)
          The text symbol used to draw the label.
 void setSymbolID(int symbolID)
          The ID of the group symbol used to draw the label.
 

Method Detail

setSymbolByRef

public void setSymbolByRef(ITextSymbol textSymbol)
                    throws IOException,
                           AutomationException
The text symbol used to draw the label.

Parameters:
textSymbol - An reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

getSymbol

public ITextSymbol getSymbol()
                      throws IOException,
                             AutomationException
The text symbol used to draw the label.

Supported Platforms

Windows, Solaris, Linux

Returns:
An reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

setSymbolID

public void setSymbolID(int symbolID)
                 throws IOException,
                        AutomationException
The ID of the group symbol used to draw the label.

Supported Platforms

Windows, Solaris, Linux

Parameters:
symbolID - The symbolID (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

getSymbolID

public int getSymbolID()
                throws IOException,
                       AutomationException
The ID of the group symbol used to draw the label.

Supported Platforms

Windows, Solaris, Linux

Returns:
The symbolID
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

setOffset

public void setOffset(double offset)
               throws IOException,
                      AutomationException
The offset between the label and the feature.

Supported Platforms

Windows, Solaris, Linux

Parameters:
offset - The offset (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

getOffset

public double getOffset()
                 throws IOException,
                        AutomationException
The offset between the label and the feature.

Supported Platforms

Windows, Solaris, Linux

Returns:
The offset
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

setBasicOverposterLayerPropertiesByRef

public void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
                                            throws IOException,
                                                   AutomationException
The overposter properties, which specify how labels are placed relative to features.

Parameters:
props - An reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

getBasicOverposterLayerProperties

public IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
                                                                  throws IOException,
                                                                         AutomationException
The overposter properties, which specify how labels are placed relative to features.

Supported Platforms

Windows, Solaris, Linux

Returns:
An reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

setExpression

public void setExpression(String expression)
                   throws IOException,
                          AutomationException
The VBScript or JScript expression that evaluates and formats the label.

Supported Platforms

Windows, Solaris, Linux

Parameters:
expression - The expression (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

getExpression

public String getExpression()
                     throws IOException,
                            AutomationException
The VBScript or JScript expression that evaluates and formats the label.

Supported Platforms

Windows, Solaris, Linux

Returns:
The expression
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

setIsExpressionSimple

public void setIsExpressionSimple(boolean simpleExpression)
                           throws IOException,
                                  AutomationException
Indicates if the expression is simple.

Supported Platforms

Windows, Solaris, Linux

Parameters:
simpleExpression - The simpleExpression (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

isExpressionSimple

public boolean isExpressionSimple()
                           throws IOException,
                                  AutomationException
Indicates if the expression is simple.

Returns:
The simpleExpression
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

setExpressionParserByRef

public void setExpressionParserByRef(IAnnotationExpressionEngine engine)
                              throws IOException,
                                     AutomationException
The object that interprets the expression.

Parameters:
engine - An reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

getExpressionParser

public IAnnotationExpressionEngine getExpressionParser()
                                                throws IOException,
                                                       AutomationException
The object that interprets the expression.

Supported Platforms

Windows, Solaris, Linux

Returns:
An reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

setAnnotationClassID

public void setAnnotationClassID(int annotationClassID)
                          throws IOException,
                                 AutomationException
The ID of the annotation class.

Supported Platforms

Windows, Solaris, Linux

Parameters:
annotationClassID - The annotationClassID (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

getAnnotationClassID

public int getAnnotationClassID()
                         throws IOException,
                                AutomationException
The ID of the annotation class.

Supported Platforms

Windows, Solaris, Linux

Returns:
The annotationClassID
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

setOverposterLayerPropertiesByRef

public void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
                                       throws IOException,
                                              AutomationException
The overposter properties, which specify how labels are placed relative to features.

Parameters:
props - An reference to a com.esri.arcgis.carto.IOverposterLayerProperties (in)
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.

getOverposterLayerProperties

public IOverposterLayerProperties getOverposterLayerProperties()
                                                        throws IOException,
                                                               AutomationException
The overposter properties, which specify how labels are placed relative to features.

Supported Platforms

Windows, Solaris, Linux

Returns:
An reference to a com.esri.arcgis.carto.IOverposterLayerProperties
Throws:
IOException - If there are communications problems.
AutomationException - If the remote server throws an exception.