com.esri.arcgis.carto
Interface ISpatialBookmark

All Superinterfaces:
Serializable
All Known Subinterfaces:
IAOIBookmark, IFeatureBookmark, IPushPin
All Known Implementing Classes:
AOIBookmark, FeatureBookmark, IPushPinProxy, ISpatialBookmarkProxy

public interface ISpatialBookmark
extends Serializable

Provides access to members that control a spatial 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getBookmarkType()
          Type of the bookmark.
 String getName()
          Name of the bookmark.
 void setName(String name)
          Name of the bookmark.
 void zoomTo(IMap map)
          Zooms to the bookmark.
 

Method Detail

getBookmarkType

String getBookmarkType()
                       throws IOException,
                              AutomationException
Type of the bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The type
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
Name of the bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException
Name of the bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomTo

void zoomTo(IMap map)
            throws IOException,
                   AutomationException
Zooms to the bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
map - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.