com.esri.arcgis.carto
Interface IMapServerBookmarks

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServerBookmarks

public interface IMapServerBookmarks
extends Serializable

Provides access to the Map Server Bookmarks Interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void add(IMapServerBookmark bookmark)
          Adds a bookmark.
 int getCount()
          The bookmark count.
 IMapServerBookmark getElement(int index)
          The bookmark at the specified position.
 void insert(int index, IMapServerBookmark bookmark)
          Adds a bookmark at the specified position.
 void remove(int index)
          Removes the bookmark at the specified position.
 void removeAll()
          Removes all bookmarks.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The bookmark count.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getElement

IMapServerBookmark getElement(int index)
                              throws IOException,
                                     AutomationException
The bookmark at the specified position.

Product Availability

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

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

remove

void remove(int index)
            throws IOException,
                   AutomationException
Removes the bookmark at the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

removeAll

void removeAll()
               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.

add

void add(IMapServerBookmark bookmark)
         throws IOException,
                AutomationException
Adds a bookmark.

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.IMapServerBookmark (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IMapServerBookmark bookmark)
            throws IOException,
                   AutomationException
Adds a bookmark at the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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