Interface IMapServerInfo

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll

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

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("47DD2772-2F22-44DF-919B-0D16D8672626")]
public interface IMapServerInfo

Properties

BackgroundColor

The background color of the map (data frame).

IColorDescription BackgroundColor { get; }

Property Value

IColorDescription

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

Bookmarks

The published bookmarks for the map.

IMapServerBookmarks Bookmarks { get; }

Property Value

IMapServerBookmarks

Remarks

Bookmarks are set in the map document itself.

CopyrightText

Copyright information associated with the layer.

string CopyrightText { get; }

Property Value

string

DefaultMapDescription

The default map settings.

IMapDescription DefaultMapDescription { get; }

Property Value

IMapDescription

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.

Description

The description of the map (data frame). This property is set in the General tab of the Data Frame Properties dialog.

string Description { get; }

Property Value

string

Extent

The current extent of the map (data frame).

IEnvelope Extent { get; }

Property Value

IEnvelope

Remarks

This is the extent of the DefaultMapDescription.

FullExtent

The full extent of the map (data frame).

IEnvelope FullExtent { get; }

Property Value

IEnvelope

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. 

MapLayerInfos

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

IMapLayerInfos MapLayerInfos { get; }

Property Value

IMapLayerInfos

MapUnits

The units for the map (data frame).

esriUnits MapUnits { get; }

Property Value

esriUnits

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.

MaxScale

The maximum visible scale for the service.

double MaxScale { get; }

Property Value

double

MinScale

The minimum visible scale for the service.

double MinScale { get; }

Property Value

double

Name

The name of the map (data frame).

string Name { get; }

Property Value

string

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.

StandaloneTableDescriptions

Standalone tables descriptions that can passed in to other methods.

IStandaloneTableDescriptions StandaloneTableDescriptions { get; }

Property Value

IStandaloneTableDescriptions

StandaloneTableInfos

Standalone tables infromation in a given map.

IStandaloneTableInfos StandaloneTableInfos { get; }

Property Value

IStandaloneTableInfos