This document is archived and information here might be outdated. Recommended version.

IMxdServer Interface (ArcObjects .NET 10.8 SDK)

Collapse All

ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IM > IMxdServer Interface

ArcGIS Developer Help

IMxdServer Interface

Provides access to members that support opening a map document and generating images of it.

Product Availability

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

Members

	Name	Description
	Bookmarks	The spatial bookmarks saved with the specified map, if any.
	DefaultMapName	The TOC Information.
	ExportLayout	Generates an image of the layout, based on the given array of map descriptors, and writes the image to a specified file on disk. Supported Image types are: 'bmp', 'jpg', 'tif', 'png', 'emf', 'eps', 'pdf', 'ai', 'pcx'.
	ExportLegend	Exports a legend to an image file. The client can create the pLegend object and set its desired properties appropriately. If pLegend is null, a default legend for the default map will be generated.
	ExportMapImage	Generates an image of the map, based on the given map descriptor, and writes the image to the specified file on disk. Supported file types are: 'bmp', 'jpg', 'tif', 'png'/'png8', 'png24', 'emf' and 'pcx'.
	ExportNorthArrow	Exports a north arrow to an image file. The client can create the pArrow object and set its desired properties appropriately. If pArrow is null, a default north arrow will be generated for the default map.
	ExportScaleBar	Exports a scale bar to an image file. The client can create the pScaleBar object and set its desired properties appropriately. If pScaleBar is null, a default scale bar will be generated for the default map.
	GetFeatureValue	The value of the specified field for the specified feature.
	GetMapBitmapHandle	Generates a picture of the map, based on the given map descriptor, and returns an HBITMAP handle to the resulting image. If you call this function, you absolutely MUST call ReleaseBitmapHandle() with the returned bitmap handle.
	GetMapPicture	Generates a picture of the map, based on the given map descriptor, and returns the image as an IPictureDisp. If pMapDescriptor is null, it draws a picture of the default map at the default extent.
	LayerDescriptors	An array of LayerDescriptor objects for a given map name. Each layer descriptor describes the characteristics of a layer in the map. Default layer properties can be changed to change output.
	MapDescriptors	An array of MapDescriptor objects, where each map descriptor describes the characteristics of a data frame in the document. The properties of a map descriptor object can be altered in order to draw the map image with different state than the default.
	ReleaseBitmapHandle	Companion function to GetBitmapHandle(). Releases the bitmap handle that is returned from that function.
	Start	Initializes the map server with an mxd file stored at the specified path. The path must be able to be located by the server machine.
	StartWithData	An alternative to calling Start() with a document name, this method synthesizes a map document with a single layer based on the given IDataset object, and initializes the map server for processing.
	Stop	Clears out all of the map objects in memory. The client must call one of the Start methods again before attempting any other operations.
	Thumbnail	The thumbnail image stored with the map document, if any. If the document has no thumbnail stored with it, this method will return E_FAIL and the returned IPictureDisp object will be null.
	TOCInfo	The TOC Information.

Classes that implement IMxdServer

Classes	Description
MxdServer	The MxdServer 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.