com.esri.arcgis.carto
Interface IHotlinkContainer

All Superinterfaces:
Serializable
All Known Implementing Classes:
CadAnnotationLayer, CadFeatureLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, IHotlinkContainerProxy, IMSSubFeatureLayer, SchematicLayer

public interface IHotlinkContainer
extends Serializable

Provides access to members that manage all the hotlinks of a layer (e.g. field based hyperlinks or those that that call macros).

Description

Hotlinks are hyperlinks that require a container (i.e. they reside on a layer) because they are either based on a field or they call a macro.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getHotlinkField()
          Field used for hotlinks.
 int getHotlinkType()
          Hotlink type.
 void setHotlinkField(String fieldName)
          Field used for hotlinks.
 void setHotlinkType(int linkType)
          Hotlink type.
 

Method Detail

getHotlinkField

String getHotlinkField()
                       throws IOException,
                              AutomationException
Field used for hotlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHotlinkField

void setHotlinkField(String fieldName)
                     throws IOException,
                            AutomationException
Field used for hotlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHotlinkType

int getHotlinkType()
                   throws IOException,
                          AutomationException
Hotlink type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriHyperlinkType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHotlinkType

void setHotlinkType(int linkType)
                    throws IOException,
                           AutomationException
Hotlink type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
linkType - A com.esri.arcgis.carto.esriHyperlinkType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.