com.esri.arcgis.carto
Interface IMapServerHyperlinks

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerHyperlinks

public interface IMapServerHyperlinks
extends Serializable

Provides access to the Map Server Hyperlinks Interface.

Product Availability

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

Method Summary

void	add(IMapServerHyperlink link) Adds a hyperlink.
int	getCount() The hyperlink count.
IMapServerHyperlink	getElement(int index) The hyperlink at the specified position.
void	insert(int index, IMapServerHyperlink link) Adds a hyperlink at the specified position.
void	remove(int index) Removes the hyperlink at the specified position.
void	removeAll() Removes all hyperlinks.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The hyperlink count.

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.

getElement

IMapServerHyperlink getElement(int index)
                               throws IOException,
                                      AutomationException

The hyperlink at the specified position.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes the hyperlink at the specified position.

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.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all hyperlinks.

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.

add

void add(IMapServerHyperlink 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.IMapServerHyperlink (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IMapServerHyperlink link)
            throws IOException,
                   AutomationException

Adds a hyperlink at the specified position.

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.IMapServerHyperlink (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.