com.esri.arcgis.carto
Interface IAnnotationExpressionParser

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnnotationExpressionParser, HotLinkExpressionParser, IAnnotationExpressionParserProxy

public interface IAnnotationExpressionParser
extends Serializable

Provides access to members to parse annotation expressions.

Superseded By

IAnnotationExpressionParser2

When To Use

The IAnnotationExpressionParser is a low level interface maintaining information about the labeling expression.

Product Availability

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

See Also:

ILabelEngineLayerProperties

Method Summary

String	findLabel(IFeature feature) The label for a given feature based on the annotation expression.
String	getAttribute(int index) The attribute fields in the expression.
int	getAttributeCount() The number of attribute fields in the expression.
String	getExpression() The annotation expression.
void	lastError(int[] number, int[] line, String[] description) Reports error that occurred in FindLabel method.

Method Detail

getExpression

String getExpression()
                     throws IOException,
                            AutomationException

The annotation expression.

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.

getAttributeCount

int getAttributeCount()
                      throws IOException,
                             AutomationException

The number of attribute fields in the expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The attributes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttribute

String getAttribute(int index)
                    throws IOException,
                           AutomationException

The attribute fields in the expression.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The attribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findLabel

String findLabel(IFeature feature)
                 throws IOException,
                        AutomationException

The label for a given feature based on the annotation expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

lastError

void lastError(int[] number,
               int[] line,
               String[] description)
               throws IOException,
                      AutomationException

Reports error that occurred in FindLabel method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

number - The number (in/out: use single element array)

line - The line (in/out: use single element array)

description - The description (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.