com.esri.arcgis.carto
Interface IAOIBookmark

All Superinterfaces:

ISpatialBookmark, Serializable

All Known Implementing Classes:

AOIBookmark

public interface IAOIBookmark
extends ISpatialBookmark, Serializable

Provides access to members that control an AOI bookmark.

Remarks

The AOIBookmark object is used to create an Area of Interest bookmark.

In ArcMap, Area of Interest bookmarks are created using the View menu's Bookmarks->Create command.

This object persists an envelope in its Location property corresponding to the current extent of the map. You can later find the bookmark by its name and set the map’s extent to be equal to the extent stored in the bookmark.

IAOIBookmark inherits from ISpatialBookmark .

To add bookmarks to the map, QueryInterface IMapBookMarks interface from IMap interface and then call the IMapBookmarks::AddBookMark method.

See also IFeatureBookmark and the examples in the Carto library overview.

Product Availability

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

Method Summary

IEnvelope	getLocation() Location of the bookmark.
void	setLocationByRef(IEnvelope location) Location of the bookmark.

Methods inherited from interface com.esri.arcgis.carto.ISpatialBookmark

getBookmarkType, getName, setName, zoomTo

Method Detail

getLocation

IEnvelope getLocation()
                      throws IOException,
                             AutomationException

Location of the bookmark.

Description

Location property contains the saved view extent of area of interest.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationByRef

void setLocationByRef(IEnvelope location)
                      throws IOException,
                             AutomationException

Location of the bookmark.

Description

Location property contains the saved view extent of area of interest.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.