com.esri.arcgis.carto
Interface IMapDescriptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapDescriptions

public interface IMapDescriptions
extends Serializable

Provides access to the Map Descriptions Interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void add(IMapDescription mapDesc)
          Adds a map description.
 int getCount()
          The map description count.
 IMapDescription getElement(int index)
          The map description at the specified position.
 void insert(int index, IMapDescription mapDesc)
          Adds a map description at the specified position.
 void remove(int index)
          Removes the map description at the specified position.
 void removeAll()
          Removes all map descriptions.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The map description 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

IMapDescription getElement(int index)
                           throws IOException,
                                  AutomationException
The map description 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.IMapDescription
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 map description 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 map descriptions.

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(IMapDescription mapDesc)
         throws IOException,
                AutomationException
Adds a map description.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

insert

void insert(int index,
            IMapDescription mapDesc)
            throws IOException,
                   AutomationException
Adds a map description 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)
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.