com.esri.arcgis.carto
Interface IMapBookmarks

All Superinterfaces:

Serializable

All Known Implementing Classes:

Map

public interface IMapBookmarks
extends Serializable

Provides access to members that control the map bookmarks.

Remarks

The collection of bookmarks in the map.

See the help for ISpatialBookmark and the examples in the Carto library overview.

Product Availability

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

Method Summary

void	addBookmark(ISpatialBookmark bookmark) Adds a bookmark to the collection.
IEnumSpatialBookmark	getBookmarks() The bookmarks.
void	removeAllBookmarks() Removes all bookmarks.
void	removeBookmark(ISpatialBookmark bookmark) Removes a bookmark from the collection.

Method Detail

getBookmarks

IEnumSpatialBookmark getBookmarks()
                                  throws IOException,
                                         AutomationException

The bookmarks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addBookmark

void addBookmark(ISpatialBookmark bookmark)
                 throws IOException,
                        AutomationException

Adds a bookmark to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bookmark - A reference to a com.esri.arcgis.carto.ISpatialBookmark (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeBookmark

void removeBookmark(ISpatialBookmark bookmark)
                    throws IOException,
                           AutomationException

Removes a bookmark from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bookmark - A reference to a com.esri.arcgis.carto.ISpatialBookmark (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllBookmarks

void removeAllBookmarks()
                        throws IOException,
                               AutomationException

Removes all bookmarks.

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.