This document is archived and information here might be outdated.  Recommended version.


ISpatialBookmark Interface (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Carto)  

ISpatialBookmark Interface

Provides access to members that control a spatial bookmark.

Product Availability

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

Members

Description
Read-only property BookmarkType Type of the bookmark.
Read/write property Name Name of the bookmark.
Method ZoomTo Zooms to the bookmark.

CoClasses that implement ISpatialBookmark

CoClasses and Classes Description
AOIBookmark An AOI bookmark.
FeatureBookmark A feature bookmark.

Remarks

The ISpatialBookmark interface defines all the common functionality of spatial bookmarks, particularly the name of the bookmark and a zoom function. Bookmarks save map extents along with a name identifying them and so make it easy to jump to a specific location on the map.

Use this interface to check the name of a spatial bookmark and zoom to the extent stored in a bookmark. The ZoomTo function changes the map�s extent via  ActiveView::Extent. ZoomTo does not automatically invalidate the display.

There are currently two types of spatial bookmarks in ArcMap: Area of Interest and Feature bookmarks. Both types of spatial bookmarks are managed by the Map object for which they store extents. Bookmarks are persisted in the map document. You can access a Map�s spatial books using the IMapBookmarks interface. This interface has methods for accessing bookmarks, adding new ones, and deleting old ones.

Implement the ISpatialBookmark interface to create new custom spatial bookmarks.

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

.NET Samples

Add a custom bookmarks MultiItem to the ToolbarControl (Code Files: SpatialBookmarks)

.NET Related Topics

How to create AOIs and bookmarks