com.esri.arcgis.carto
Interface IDisplayString

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadAnnotationLayer, CadastralFabricSubLayer, CadFeatureLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, IDisplayStringProxy, IMSSubFeatureLayer, StandaloneTable, TemporalFeatureLayer

public interface IDisplayString
extends Serializable

Provides access to members that work with a layer's display expression.

When To Use

This interface can return or set the display expression properties for a layer. You can also return the evaluated display string for a given feature.

Product Availability

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

Method Summary

String	findDisplayString(IObject pObject) Finds the display string for the given feature based on the current expression properties.
IDisplayExpressionProperties	getExpressionProperties() Properties that describe the display expression.
void	setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties) Properties that describe the display expression.

Method Detail

getExpressionProperties

IDisplayExpressionProperties getExpressionProperties()
                                                     throws IOException,
                                                            AutomationException

Properties that describe the display expression.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionPropertiesByRef

void setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
                                  throws IOException,
                                         AutomationException

Properties that describe the display expression.

Product Availability

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

Parameters:

displayExpressionProperties - A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findDisplayString

String findDisplayString(IObject pObject)
                         throws IOException,
                                AutomationException

Finds the display string for the given feature based on the current expression properties.

Product Availability

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

Parameters:

pObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.