com.esri.arcgis.carto
Interface IMxdServerObjects

All Superinterfaces:

Serializable

All Known Implementing Classes:

MxdServer

public interface IMxdServerObjects
extends Serializable

Provides access to the core objects contained within the map document.

Product Availability

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

Method Summary

ILayer	getLayer(String mapName, int layerID) The layer specified by the map name and layer ID.
IMap	getMap(String mapName) The map corresponding to the specified map name.
IPageLayout	getPageLayout() The page layout object for the current map document.

Method Detail

getMap

IMap getMap(String mapName)
            throws IOException,
                   AutomationException

The map corresponding to the specified map name. Pass in a blank string for mapName to get the default map. If the mapName does not correspond to any map in the document, E_INVALIDARG is returned and ppMap will be null.

Product Availability

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

Parameters:

mapName - The mapName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(String mapName,
                int layerID)
                throws IOException,
                       AutomationException

The layer specified by the map name and layer ID. If the mapName is blank, the default map will be assumed. If the map or layer specified is not found, an E_INVALIDARG error will be returned.

Product Availability

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

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageLayout

IPageLayout getPageLayout()
                          throws IOException,
                                 AutomationException

The page layout object for the current map document.

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.IPageLayout

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.