ArcObjects Library Reference (Carto)  

IMapServer2 Interface

Provides access to members that serve maps.

Product Availability

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

Description

Note: the IMapServer2 interface has been superseded by IMapServer3

When To Use

Use IMapServer2 to display, export and query ArcGIS map documents in either desktop, LAN/WAN, or internet development environments.

Members

Description
Method ComputeDistance Computes the distance between two points on the specified map. The result is in the map units of the specified map.
Method ComputeScale Computes the scale of the specified map, at the given map extent, for an image with the given size.
Read-only property DefaultMapName Name of the document's active map (data frame).
Read-only property DocumentInfo A set of name-value pairs for properties set for the map document (mxd only). These properties are string values set in the map document's Map Properties dialog and include: Title, Subject, Author, Category, Keywords and Comments.
Method ExportMapImage Generates an image of the map, based on the given map description, and writes the image to a specified file on disk. Supported file types are: 'bmp', 'jpg', 'tif', 'png'/'png8', 'png24', 'emf', 'ps', 'pdf', 'ai', 'gif', and 'svg'/'svgz'.
Method ExportScaleBar Exports a scale bar to an image file. The client can create the scaleBar object and set its desired properties appropriately. If scaleBar is Nothing/Null, a default scale bar will be generated.
Method Find Returns a collection of Map Server Find Result objects that contain the given search string. If LayerIDs is Nothing/Null or empty, all layers are searched.
Method FromMapPoints Converts a map coordinate to a screen location.
Method GetLegendInfo Returns a collection of Map Server Legend Info objects for the specified layers. If layerIDs is Nothing/Null or empty, legend information for all layers is returned.
Method GetServerInfo Returns information about a map (data frame).
Method GetSQLSyntaxInfo Returns the SQL syntax information for the specified layer.
Method GetSupportedImageReturnTypes The supported image return types for the map server. A value of esriImageReturnMimeData means that only MIME data is supported. Otherwise, either MIME data or URLs are supported.
Method Identify Returns a collection of Map Server Identify Result objects at the given location. If LayerIDs is Nothing/Null or empty, all layers are searched.
Read-only property MapCount The number of maps (data frames) in the document.
Read-only property MapName Name of the map (data frame) as indicated by the index. The first beginning with 0.
Method QueryFeatureCount Returns the count of the features that meet the query filter selection criteria for the specified layer.
Method QueryFeatureCount2 Returns the count of the features that meet the query filter selection criteria for the specified layer.
Method QueryFeatureData Returns a record set of features that meet the query filter selection criteria for the specified layer.
Method QueryFeatureData2 Returns a record set of features that meet the query filter selection criteria for the specified layer.
Method QueryFeatureIDs Returns the IDs of the features that meet the query filter selection criteria for the specified layer.
Method QueryFeatureIDs2 Returns the IDs of the features that meet the query filter selection criteria for the specified layer.
Method QueryHyperlinks Returns a collection of Map Server Hyperlink objects for the specified layers. Only hyperlinks of visible layers are returned. If LayerIDs is Nothing/Null or empty, all layers are searched.
Read-only property ServiceConfigurationInfo A set of name-value pairs for properties set for the MapServer Service Configuration Restrictions.
Method ToMapPoints Converts a screen location to a map coordinate.

CoClasses that implement IMapServer2

CoClasses and Classes Description
MapServer The MapServer component provides programmatic access to the contents of a map document on disk, and creates images of the map contents based on user requests. Designed for use in building map-based web services and web applications.
MapServerIP Map Server Message Proxy.
MapServerLP Map Server LAN Proxy.

Remarks

MapServer is a coarse-grained ArcObject. MapServer provides limited interaction with the map through a group of related "MapServer" coclasses and interfaces. IMapServer2 includes methods to export a map image (ExportMapImage), query features in the map (Identify, Find, QueryFeatureCount, QueryFeatureCount2, QueryFeatureIDs, QueryFeatureIDs2QueryFeatureData and QueryFeatureData2). IMapServer2 is not an implementable interface. Custom server objects cannot be created.