com.esri.arcgis.carto
Interface IMapServerInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServerInfo

public interface IMapServerInfo
extends Serializable

Provides access to the available properties of a map server info object.

Superseded By

IMapServerInfo2

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IColor getBackgroundColor()
          The background color of the map (data frame).
 IMapServerBookmarks getBookmarks()
          The published bookmarks for the map.
 IMapDescription getDefaultMapDescription()
          The default map settings.
 String getDescription()
          The description of the map (data frame).
 IEnvelope getExtent()
          The current extent of the map (data frame).
 IEnvelope getFullExtent()
          The full extent of the map (data frame).
 IMapLayerInfos getMapLayerInfos()
          A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).
 int getMapUnits()
          The units for the map (data frame).
 String getName()
          The name of the map (data frame).
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
The name of the map (data frame).

Remarks

If two (or more) data frames have the same name in the map document, MapServer adds a distinctive number at the end of the second name. E.g. Layers and Layers2.

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.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
The description of the map (data frame). This property is set in the General tab of the Data Frame Properties dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFullExtent

IEnvelope getFullExtent()
                        throws IOException,
                               AutomationException
The full extent of the map (data frame).

Remarks

The full extent of the map can either be the combined extent of all layers within the map or a custom full extent set by on the data frame by the author of the map document being served.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The current extent of the map (data frame).

Remarks

This is the extent of the DefaultMapDescription.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapLayerInfos

IMapLayerInfos getMapLayerInfos()
                                throws IOException,
                                       AutomationException
A collection of Map Layer Info objects, each containing information about a layer in the map (data frame).

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

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
The background color of the map (data frame).

Remarks

The background color is set in the map document itself. If background color is not explicitly set in the original mxd, the default color is set to an off-white color (RGB value of 253,253,253).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBookmarks

IMapServerBookmarks getBookmarks()
                                 throws IOException,
                                        AutomationException
The published bookmarks for the map.

Remarks

Bookmarks are set in the map document itself.

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

getDefaultMapDescription

IMapDescription getDefaultMapDescription()
                                         throws IOException,
                                                AutomationException
The default map settings.

Remarks

The DefaultMapDescription refers to map settings set in the original map document. Changes to map settings using IMapDescription are temporary and do not affect the default map description returned by DefaultMapDescription.

The default settings for a MapServer object can be changed in two ways. First, you can make changes to the original map document and reinitialize the MapServer object. The other way to change the DefaultMapDescription is to use IMapServerObjects to access the fine-grained ArcObjects that the map settings are based, make the desired changes, and use the RefreshServerObjects method to overwite the old DefaultMapDescription with a new one. This should be done with objects in a non-pooled environment. Changing the state of pooled objects this way will lead to unexpected results.

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

getMapUnits

int getMapUnits()
                throws IOException,
                       AutomationException
The units for the map (data frame).

Remarks

The map units are set in the map document itself and cannot be changed using MapServer. The map's original spatial reference determines the units. Changing the SpatialReference property of IMapDescription will not change the value of the MapUnits property on IMapServerInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.