com.esri.arcgis.carto
Interface ILabelEngineLayerProperties2

All Superinterfaces:

Serializable

All Known Implementing Classes:

LabelEngineLayerProperties, MaplexLabelEngineLayerProperties

public interface ILabelEngineLayerProperties2
extends Serializable

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

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.

Product Availability

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

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

void setSymbolByRef(ITextSymbol textSymbol)
                    throws IOException,
                           AutomationException

The text symbol used to draw the label.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

ITextSymbol getSymbol()
                      throws IOException,
                             AutomationException

The text symbol used to draw the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolID

void setSymbolID(int symbolID)
                 throws IOException,
                        AutomationException

The ID of the group symbol used to draw the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbolID - The symbolID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbolID

int getSymbolID()
                throws IOException,
                       AutomationException

The ID of the group symbol used to draw the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The symbolID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

void setOffset(double offset)
               throws IOException,
                      AutomationException

The offset between the label and the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

offset - The offset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

double getOffset()
                 throws IOException,
                        AutomationException

The offset between the label and the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBasicOverposterLayerPropertiesByRef

void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
                                            throws IOException,
                                                   AutomationException

The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Parameters:

props - A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBasicOverposterLayerProperties

IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
                                                                  throws IOException,
                                                                         AutomationException

The overposter properties, which specify how labels are placed relative to features.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

void setExpression(String expression)
                   throws IOException,
                          AutomationException

The VBScript or JScript expression that evaluates and formats the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

expression - The expression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpression

String getExpression()
                     throws IOException,
                            AutomationException

The VBScript or JScript expression that evaluates and formats the label.

Description

Expression is the expression that evaluates and formats the label (text). This can be a simple as a single field name enclosed in brackets or as complex as a script written in the language specified by the ExpressionParser. If the expression is a script it must contain a function call FindLabel and the IsExpressionSimple property should be set to FALSE.

Remarks

This can be based on either VBScript or JavaScript.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsExpressionSimple

void setIsExpressionSimple(boolean simpleExpression)
                           throws IOException,
                                  AutomationException

Indicates if the expression is simple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

simpleExpression - The simpleExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpressionSimple

boolean isExpressionSimple()
                           throws IOException,
                                  AutomationException

Indicates if the expression is simple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The simpleExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionParserByRef

void setExpressionParserByRef(IAnnotationExpressionEngine engine)
                              throws IOException,
                                     AutomationException

The object that interprets the expression.

Product Availability

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

Parameters:

engine - A reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpressionParser

IAnnotationExpressionEngine getExpressionParser()
                                                throws IOException,
                                                       AutomationException

The object that interprets the expression.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnnotationClassID

void setAnnotationClassID(int annotationClassID)
                          throws IOException,
                                 AutomationException

The ID of the annotation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

annotationClassID - The annotationClassID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnnotationClassID

int getAnnotationClassID()
                         throws IOException,
                                AutomationException

The ID of the annotation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The annotationClassID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverposterLayerPropertiesByRef

void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
                                       throws IOException,
                                              AutomationException

The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Parameters:

props - A reference to a com.esri.arcgis.carto.IOverposterLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverposterLayerProperties

IOverposterLayerProperties getOverposterLayerProperties()
                                                        throws IOException,
                                                               AutomationException

The overposter properties, which specify how labels are placed relative to features.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.