com.esri.arcgis.carto
Interface IHotlinkExpression

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadAnnotationLayer, CadastralFabricSubLayer, CadFeatureLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, IHotlinkExpressionProxy, IMSSubFeatureLayer

public interface IHotlinkExpression
extends Serializable

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

Product Availability

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

Method Summary

String	executeExpression(IObject pObject) Finds the hyperlink for the given feature based on the current expression properties.
IHotLinkExpressionProperties	IHotlinkExpression_getExpressionProperties() Properties that describe the hyperlink expression.
void	setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties) Properties that describe the hyperlink expression.

Method Detail

IHotlinkExpression_getExpressionProperties

IHotLinkExpressionProperties IHotlinkExpression_getExpressionProperties()
                                                                        throws IOException,
                                                                               AutomationException

Properties that describe the hyperlink expression.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionPropertiesByRef

void setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties)
                                  throws IOException,
                                         AutomationException

Properties that describe the hyperlink expression.

Product Availability

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

Parameters:

ppHotLinkExpressionProperties - A reference to a com.esri.arcgis.carto.IHotLinkExpressionProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

executeExpression

String executeExpression(IObject pObject)
                         throws IOException,
                                AutomationException

Finds the hyperlink 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.