com.esri.arcgis.carto
Interface IAnnotationExpressionEngine

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnnotationJScriptEngine, AnnotationVBScriptEngine

public interface IAnnotationExpressionEngine
extends Serializable

Provides access to members that work with low level information about a script based labeling expression.

When To Use

The IAnnotationExpressionEngine interface is implemented by the script engine coclasses. This is a low level interface maintaining information about the labeling expression.

The AppendCode property provides the language specific characters needed to append two strings.

The CreateFunction method creates a simple expression properly formatted for the parser language.

The SetCode and SetExpression are used to set the label expression into the parser. SetCode is used for adavanced expressions while SetExpression is used for simple expressions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILabelEngineLayerProperties

Method Summary
 String createFunction(String name, String parameters, String expression)
          Creates the specified function.
 String getAppendCode()
          The code to append.
 String getName()
          The name of the expression engine.
 IAnnotationExpressionParser setCode(String fullCode, String runFunction)
          The function to base labels on.
 IAnnotationExpressionParser setExpression(String preCode, String expression)
          The expression to base labels on.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
The name of the expression engine.

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.

getAppendCode

String getAppendCode()
                     throws IOException,
                            AutomationException
The code to append.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

createFunction

String createFunction(String name,
                      String parameters,
                      String expression)
                      throws IOException,
                             AutomationException
Creates the specified function.

Remarks

The CreateFunction methods is used to convert a simple expression into an Advanced Expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
parameters - The parameters (in)
expression - The expression (in)
Returns:
The function
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpression

IAnnotationExpressionParser setExpression(String preCode,
                                          String expression)
                                          throws IOException,
                                                 AutomationException
The expression to base labels on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCode

IAnnotationExpressionParser setCode(String fullCode,
                                    String runFunction)
                                    throws IOException,
                                           AutomationException
The function to base labels on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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