com.esri.arcgis.carto
Interface IMapServerInfo2

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerInfo

public interface IMapServerInfo2
extends Serializable

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

Remarks

IMapServerInfo provides access to members describing the default state of a MapServer object, such as the name of the map, the background color or the spatial extent of the map. This information cannot be changed without changing the state of the underlying fine-grained ArcObjects.

Map settings of the Server object can be permanently changed by accessing fine-grained ArcObjects. This is accomplished using IMapServerObjects2. This should be done with objects in a non-pooled environment. Changing the state of pooled objects this way will lead to unexpected results.

Please note the difference between IMapServerInfo and IMapDescription2. IMapServerInfo provides read-only access to its members. IMapDescription2 provided read-write access to its members. Use IMapDescription2 to access and change map settings without changing the state of the fine-grained ArcObejcts.

When To Use

Use the IMapServerInfo interface to access read-only information about a map (data frame).

Product Availability

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

Method Summary

IColor	getBackgroundColor() The background color of the map (data frame).
IFillSymbol	getBackgroundSymbol() Background symbol of the map (data frame).
IMapServerBookmarks	getBookmarks() The published bookmarks for the map.
String	getCopyrightText() Copyright information associated with the layer.
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).

Product Availability

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

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.

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.

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

Product Availability

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

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.

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.

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.

Product Availability

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

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.

Product Availability

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

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

Product Availability

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundSymbol

IFillSymbol getBackgroundSymbol()
                                throws IOException,
                                       AutomationException

Background symbol of the map (data frame).

Remarks

If the background symbol and color are not explicitly set in the original map document (.mxd), the default background symbol is a polygon. The polygon will have a solid fill with an off-white color (RGB value of 253,253,253).

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCopyrightText

String getCopyrightText()
                        throws IOException,
                               AutomationException

Copyright information associated with the layer.

Product Availability

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

Returns:

The copyright

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.