Class MapServerInfoClass

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("927B6010-1AC9-470F-99B5-BF95C98B9339")]
public class MapServerInfoClass : MapServerInfo, IMapServerInfo, IXMLSerialize, IPersistStream, IPersist, IMapServerTimeInfo
Inheritance
MapServerInfoClass
Implements
Inherited Members

Constructors

MapServerInfoClass()

public MapServerInfoClass()

Explicit Interface Implementations

BackgroundColor

The background color of the map (data frame).

virtual IColorDescription BackgroundColor { get; }

Returns

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.

virtual IMapServerBookmarks Bookmarks { get; }

Returns

IMapServerBookmarks

Remarks

Bookmarks are set in the map document itself.

CopyrightText

Copyright information associated with the layer.

virtual string CopyrightText { get; }

Returns

string

DefaultMapDescription

The default map settings.

virtual IMapDescription DefaultMapDescription { get; }

Returns

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.

DefaultTimeInterval

The recommended default time interval to be used to animate the layer/table in the service.

virtual double DefaultTimeInterval { get; }

Returns

double

DefaultTimeIntervalUnits

The recommended default time interval units to be used to animate the layer/table in the service.

virtual esriTimeUnits DefaultTimeIntervalUnits { get; }

Returns

esriTimeUnits

DefaultTimeWindow

The recommended time window expressed in the same units as the time interval for the service.

virtual double DefaultTimeWindow { get; }

Returns

double

Description

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

virtual string Description { get; }

Returns

string

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

Extent

The current extent of the map (data frame).

virtual IEnvelope Extent { get; }

Returns

IEnvelope

Remarks

This is the extent of the DefaultMapDescription.

FullExtent

The full extent of the map (data frame).

virtual IEnvelope FullExtent { get; }

Returns

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. 

FullTimeExtent

TimeExtent of interest that the map as been authored.

virtual ITimeExtent FullTimeExtent { get; }

Returns

ITimeExtent

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IPersist_GetClassID(out Guid)

virtual void IPersist_GetClassID(out Guid pClassID)

Parameters

pClassID Guid

IsDirty()

virtual void IsDirty()

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

MapLayerInfos

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

virtual IMapLayerInfos MapLayerInfos { get; }

Returns

IMapLayerInfos

MapUnits

The units for the map (data frame).

virtual esriUnits MapUnits { get; }

Returns

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.

virtual double MaxScale { get; }

Returns

double

MinScale

The minimum visible scale for the service.

virtual double MinScale { get; }

Returns

double

Name

The name of the map (data frame).

virtual string Name { get; }

Returns

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.

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

StandaloneTableDescriptions

Standalone tables descriptions that can passed in to other methods.

virtual IStandaloneTableDescriptions StandaloneTableDescriptions { get; }

Returns

IStandaloneTableDescriptions

StandaloneTableInfos

Standalone tables infromation in a given map.

virtual IStandaloneTableInfos StandaloneTableInfos { get; }

Returns

IStandaloneTableInfos