com.esri.arcgis.carto
Interface IDisplayExpressionProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

DisplayExpressionProperties

public interface IDisplayExpressionProperties
extends Serializable

Provides access to the properties for generating a display string.

Remarks

The display expression allows you to provide a VBScript or JScript expression to use as the display field within ArcMap rather than just a single field. This is usefull if you want to display a map tip as a concatontation or a function of several fields. The value of the resulting display expression is also displayed in the identify and attribute windows if set.

The display expression formula is set via the Expression method on this interface. The resulting display expresion can be quieried for a feature via the IDisplayString.FindDisplayString method.

Note that if you set the display field of a layer to a single field via IFeatureLayer.DisplayField that will fail if a display expression is set. You will need to clear the display expression first by setting the expression to an empty string.

Product Availability

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

Method Summary

String	getExpression() The VBScript or JScript expression that evaluates and formats the label.
IAnnotationExpressionEngine	getExpressionParser() The object that interprets the expression.
boolean	isExpressionSimple() Indicates if the expression is simple.
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.

Method Detail

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.

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.

Product Availability

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

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.

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.

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.

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.