com.esri.arcgis.carto
Class IDisplayStringProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IDisplayStringProxy

All Implemented Interfaces:

IDisplayString, Externalizable, Serializable

public class IDisplayStringProxy
extends com.esri.arcgis.interop.Dispatch
implements IDisplayString, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IDisplayStringProxy()
	IDisplayStringProxy(Object obj)
protected	IDisplayStringProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
void	setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties) Properties that describe the display expression.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IDisplayStringProxy

public IDisplayStringProxy()

IDisplayStringProxy

public IDisplayStringProxy(Object obj)
                    throws IOException

Throws:

IOException

IDisplayStringProxy

protected IDisplayStringProxy(Object obj,
                              String iid)
                       throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getExpressionProperties

public IDisplayExpressionProperties getExpressionProperties()
                                                     throws IOException,
                                                            AutomationException

Properties that describe the display expression.

Product Availability

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

Specified by:

getExpressionProperties in interface IDisplayString

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

public void setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
                                  throws IOException,
                                         AutomationException

Properties that describe the display expression.

Product Availability

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

Specified by:

setExpressionPropertiesByRef in interface IDisplayString

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

public 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.

Specified by:

findDisplayString in interface IDisplayString

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.