com.esri.arcgis.carto
Interface IMapServerObjects

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServer

public interface IMapServerObjects
extends Serializable

Provides access to core objects contained within the map document.

Superseded By

IMapServerObjects2

When To Use

This interface is not supported by optimized MapServer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void applyMapDescription(IMapDescription mapDescription, IImageDisplay mapDisplay)
          Applies the current state of the map description to the map server object.
 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.
 Picture getThumbnail()
          The thumbnail stored in the map document.
 void refreshServerObjects()
          Updates the server info based on the current state of the underlying fine-grained objects.
 

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 (active data frame).

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 (active data frame) will be assumed.

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.

getThumbnail

Picture getThumbnail()
                     throws IOException,
                            AutomationException
The thumbnail stored in the 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.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshServerObjects

void refreshServerObjects()
                          throws IOException,
                                 AutomationException
Updates the server info based on the current state of the underlying fine-grained objects.

Remarks

Use RefreshServerObjects when you have made changes to the fine-grained ArcObjects and want to apply them to the MapServer object. Keep in mind that this will change the default state of the MapServer object. In order to get the updated MapDescription, you have to call GetServerInfo on IMapServer2 again.

Any custom graphics (IMapDescription2 or IPageDescription) set previous to the RefreshServerObjects call will be lost. You will need to repeat the code for the custom graphics.

RefreshServerObjects does not refresh the extent on IPageDescription . Therefore, if you have zoomed to a particular extent of the page layout using the fine-grained ArcObjects (IActiveView) and you want to apply this extent to the PageDescription, you have to do this manually.

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.

applyMapDescription

void applyMapDescription(IMapDescription mapDescription,
                         IImageDisplay mapDisplay)
                         throws IOException,
                                AutomationException
Applies the current state of the map description to the map server object.

Remarks

Use ApplyMapDescription to apply changes made in IMapDescription2 to the map server object. ApplyMapDescription will not apply any custom graphics (IMapDescription2 or IPageDescription) to the map server object. See the following example on how to apply custom graphics to the map server object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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