com.esri.arcgis.carto
Interface IHyperlinkContainer

All Superinterfaces:

Serializable

All Known Implementing Classes:

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

public interface IHyperlinkContainer
extends Serializable

Provides access to members that manage all the hyperlinks of a layer.

Description

Manages the so-called dynamic hyperlinks in a layer. These hyperlinks are not dependent on a field and do not call a macro.

Product Availability

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

Method Summary

void	addHyperlink(IHyperlink link) Adds a hyperlink.
IHyperlink	getHyperlink(int index) The hyperlink at the specified index.
int	getHyperlinkCount() Number of hyperlinks.
void	removeHyperlink(int index) Removes the hyperlink at the specified index.
void	setHyperlinkByRef(int index, IHyperlink link) The hyperlink at the specified index.

Method Detail

getHyperlinkCount

int getHyperlinkCount()
                      throws IOException,
                             AutomationException

Number of hyperlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHyperlink

IHyperlink getHyperlink(int index)
                        throws IOException,
                               AutomationException

The hyperlink at the specified index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHyperlinkByRef

void setHyperlinkByRef(int index,
                       IHyperlink link)
                       throws IOException,
                              AutomationException

The hyperlink at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

link - A reference to a com.esri.arcgis.carto.IHyperlink (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addHyperlink

void addHyperlink(IHyperlink link)
                  throws IOException,
                         AutomationException

Adds a hyperlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

link - A reference to a com.esri.arcgis.carto.IHyperlink (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeHyperlink

void removeHyperlink(int index)
                     throws IOException,
                            AutomationException

Removes the hyperlink at the specified index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.