com.esri.arcgis.carto
Interface IMapServerHyperlink

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerHyperlink

public interface IMapServerHyperlink
extends Serializable

Provides access to the Map Server Hyperlink Interface.

When To Use

Use IMapServerHyperlink to access properties of map features returned as a result of using the IMapServer QueryHyperlinks method.

Product Availability

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

Method Summary

IGeometry	getLocation() The geometry of the feature having a hyperlink.
String	getURL() The URL of the hyperlink.
void	setLocationByRef(IGeometry location) The geometry of the feature having a hyperlink.
void	setURL(String uRL) The URL of the hyperlink.

Method Detail

getLocation

IGeometry getLocation()
                      throws IOException,
                             AutomationException

The geometry of the feature having a hyperlink.

Remarks

Location contains the geometry of a feature returned from a MapServer QueryHyperlinks query. This geometry have the same spatial reference system as the DefaultMapDescription.

In some cases you may want limit or adjust the geometry being returned. This can be done for security or performance reasons. Use ILayerResultOptions to manage this. It is important to note that the IncludeGeometry setting will have no affect on Location. A MapServerHyperlink Location will always have geometry. You can use GeometryResultOptions to densify or generalize Location geometry. Densification is used to better support clients that do not support Arcs (e.g. Bezier, Circular etc.). Generalization reduces the amount of geography being sent across the network and should lead to better performance.

Densified or generalized geometry should only be used for navigation or display purpose, such as zooming to, flashing, or highlighting the selected feature. For spatial queries, GeometryResultOptions should not be used as it may returns unexpected results. For more information on please see IGeometry, Densify, and Generalize .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationByRef

void setLocationByRef(IGeometry location)
                      throws IOException,
                             AutomationException

The geometry of the feature having a hyperlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

location - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURL

String getURL()
              throws IOException,
                     AutomationException

The URL of the hyperlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURL

void setURL(String uRL)
            throws IOException,
                   AutomationException

The URL of the hyperlink.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.