com.esri.arcgis.cartoUI
Class AnnotationExpressionProperties

java.lang.Object
  com.esri.arcgis.cartoUI.AnnotationExpressionProperties

All Implemented Interfaces:

IAnnotationExpressionProperties, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AnnotationExpressionProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotationExpressionProperties

An Esri annotation expression properties.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

AnnotationExpressionProperties(Object obj)
Construct a AnnotationExpressionProperties using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
IFeatureClass	getDisplayFeatureClass() Feature class for testing the expression.
String	getExpression() The expression.
IAnnotationExpressionEngine	getExpressionParser() The expression parser.
int	hashCode() the hashcode for this object
boolean	isExpressionSimple() Indicates if expression is simple.
void	setDisplayFeatureClassByRef(IFeatureClass featureClass) Feature class for testing the expression.
void	setExpression(String expression) The expression.
void	setExpressionParserByRef(IAnnotationExpressionEngine parser) The expression parser.
void	setIsExpressionSimple(boolean isSimple) Indicates if expression is simple.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AnnotationExpressionProperties

public AnnotationExpressionProperties(Object obj)
                               throws IOException

Construct a AnnotationExpressionProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AnnotationExpressionProperties.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
AnnotationExpressionProperties o = (AnnotationExpressionProperties)obj; // will not work

AnnotationExpressionProperties o = new AnnotationExpressionProperties(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems AnnotationExpressionProperties theAnnotationExpressionProperties = (AnnotationExpressionProperties) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getExpression

public String getExpression()
                     throws IOException,
                            AutomationException

The expression.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getExpression in interface IAnnotationExpressionProperties

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

public void setExpression(String expression)
                   throws IOException,
                          AutomationException

The expression.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setExpression in interface IAnnotationExpressionProperties

Parameters:

expression - The expression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsExpressionSimple

public void setIsExpressionSimple(boolean isSimple)
                           throws IOException,
                                  AutomationException

Indicates if expression is simple.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setIsExpressionSimple in interface IAnnotationExpressionProperties

Parameters:

isSimple - The isSimple (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpressionSimple

public boolean isExpressionSimple()
                           throws IOException,
                                  AutomationException

Indicates if expression is simple.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isExpressionSimple in interface IAnnotationExpressionProperties

Returns:

The isSimple

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionParserByRef

public void setExpressionParserByRef(IAnnotationExpressionEngine parser)
                              throws IOException,
                                     AutomationException

The expression parser.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setExpressionParserByRef in interface IAnnotationExpressionProperties

Parameters:

parser - 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

public IAnnotationExpressionEngine getExpressionParser()
                                                throws IOException,
                                                       AutomationException

The expression parser.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getExpressionParser in interface IAnnotationExpressionProperties

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.

setDisplayFeatureClassByRef

public void setDisplayFeatureClassByRef(IFeatureClass featureClass)
                                 throws IOException,
                                        AutomationException

Feature class for testing the expression.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDisplayFeatureClassByRef in interface IAnnotationExpressionProperties

Parameters:

featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayFeatureClass

public IFeatureClass getDisplayFeatureClass()
                                     throws IOException,
                                            AutomationException

Feature class for testing the expression.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDisplayFeatureClass in interface IAnnotationExpressionProperties

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.