com.esri.arcgis.carto
Interface IHyperlink

All Superinterfaces:

Serializable

All Known Implementing Classes:

Hyperlink

public interface IHyperlink
extends Serializable

Provides access to members that control a dynamic hyperlink (i.e. one that can exist with or without a container).

Description

Hyperlinks are more self-contained and flexible than hotlinks.

Product Availability

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

Method Summary

int	getFeatureId() Id for the feature that contains the hyperlink.
String	getLink() Hyperlink target.
int	getLinkType() Hyperlink type.
void	jump() Jumps to the hyperlink target.
void	setFeatureId(int fID) Id for the feature that contains the hyperlink.
void	setLink(String link) Hyperlink target.
void	setLinkType(int linkType) Hyperlink type.

Method Detail

getFeatureId

int getFeatureId()
                 throws IOException,
                        AutomationException

Id for the feature that contains the hyperlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureId

void setFeatureId(int fID)
                  throws IOException,
                         AutomationException

Id for the feature that contains the hyperlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fID - The fID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLink

String getLink()
               throws IOException,
                      AutomationException

Hyperlink target.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The link

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLink

void setLink(String link)
             throws IOException,
                    AutomationException

Hyperlink target.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

link - The link (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkType

int getLinkType()
                throws IOException,
                       AutomationException

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

setLinkType

void setLinkType(int linkType)
                 throws IOException,
                        AutomationException

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

jump

void jump()
          throws IOException,
                 AutomationException

Jumps to the hyperlink target.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.