com.esri.arcgis.carto
Interface IMxdServer

All Superinterfaces:

Serializable

All Known Implementing Classes:

MxdServer

Deprecated. This interface has been replaced by IMapServer.

public interface IMxdServer
extends Serializable

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.

Method Summary

IEnvelope	exportLayout(IArray mapDescriptors, int dpi, int imageWidth, int imageHeight, IEnvelope pageExtent, String fileType, String outputFileName) Deprecated. Generates an image of the layout, based on the given array of map descriptors, and writes the image to a specified file on disk.
void	exportLegend(ILegend legend, IMapDescriptor mapDescriptor, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, String fileType, String outputFileName) Deprecated. Exports a legend to an image file.
IEnvelope	exportMapImage(IMapDescriptor mapDescriptor, int dpi, int imageWidth, int imageHeight, String fileType, String outputFileName) Deprecated. Generates an image of the map, based on the given map descriptor, and writes the image to the specified file on disk.
void	exportNorthArrow(INorthArrow arrow, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, String fileType, String outputFileName) Deprecated. Exports a north arrow to an image file.
void	exportScaleBar(IScaleBar scalebar, int mapImageWidthPixels, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, String fileType, String outputFileName) Deprecated. Exports a scale bar to an image file.
IEnumSpatialBookmark	getBookmarks(String mapName) Deprecated. The spatial bookmarks saved with the specified map, if any.
String	getDefaultMapName() Deprecated. The TOC Information.
String	getFeatureValue(String mapName, int layerID, IFeature feature, String fieldName) Deprecated. The value of the specified field for the specified feature.
IArray	getLayerDescriptors(String mapName) Deprecated. An array of LayerDescriptor objects for a given map name.
int	getMapBitmapHandle(IMapDescriptor mapDescriptor, int dpi, tagRECT pixelBounds) Deprecated. Generates a picture of the map, based on the given map descriptor, and returns an HBITMAP handle to the resulting image.
IArray	getMapDescriptors() Deprecated. An array of MapDescriptor objects, where each map descriptor describes the characteristics of a data frame in the document.
Picture	getMapPicture(IMapDescriptor mapDescriptor, int dpi, tagRECT pixelBounds) Deprecated. Generates a picture of the map, based on the given map descriptor, and returns the image as an IPictureDisp.
Picture	getThumbnail() Deprecated. The thumbnail image stored with the map document, if any.
IArray	getTOCInfo(String mapName, int layerID) Deprecated. The TOC Information.
void	releaseBitmapHandle(int hBmp) Deprecated. Companion function to GetBitmapHandle().
void	start(String mxdPath) Deprecated. Initializes the map server with an mxd file stored at the specified path.
void	startWithData(IDataset pDataset) Deprecated. 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.
void	stop() Deprecated. Clears out all of the map objects in memory.

Method Detail

start

void start(String mxdPath)
           throws IOException,
                  AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mxdPath - The mxdPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startWithData

void startWithData(IDataset pDataset)
                   throws IOException,
                          AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

void stop()
          throws IOException,
                 AutomationException

Deprecated.

Clears out all of the map objects in memory. The client must call one of the Start methods again before attempting any other operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapDescriptors

IArray getMapDescriptors()
                         throws IOException,
                                AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptors

IArray getLayerDescriptors(String mapName)
                           throws IOException,
                                  AutomationException

Deprecated.

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.

Product Availability

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

Parameters:

mapName - The mapName (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBookmarks

IEnumSpatialBookmark getBookmarks(String mapName)
                                  throws IOException,
                                         AutomationException

Deprecated.

The spatial bookmarks saved with the specified map, if any.

Product Availability

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

Parameters:

mapName - The mapName (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumSpatialBookmark

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

Picture getThumbnail()
                     throws IOException,
                            AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapPicture

Picture getMapPicture(IMapDescriptor mapDescriptor,
                      int dpi,
                      tagRECT pixelBounds)
                      throws IOException,
                             AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapBitmapHandle

int getMapBitmapHandle(IMapDescriptor mapDescriptor,
                       int dpi,
                       tagRECT pixelBounds)
                       throws IOException,
                              AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

Returns:

The hBmp (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

releaseBitmapHandle

void releaseBitmapHandle(int hBmp)
                         throws IOException,
                                AutomationException

Deprecated.

Companion function to GetBitmapHandle(). Releases the bitmap handle that is returned from that function.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

hBmp - The hBmp (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportMapImage

IEnvelope exportMapImage(IMapDescriptor mapDescriptor,
                         int dpi,
                         int imageWidth,
                         int imageHeight,
                         String fileType,
                         String outputFileName)
                         throws IOException,
                                AutomationException

Deprecated.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

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.

exportLayout

IEnvelope exportLayout(IArray mapDescriptors,
                       int dpi,
                       int imageWidth,
                       int imageHeight,
                       IEnvelope pageExtent,
                       String fileType,
                       String outputFileName)
                       throws IOException,
                              AutomationException

Deprecated.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapDescriptors - A reference to a com.esri.arcgis.system.IArray (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

pageExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

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.

exportLegend

void exportLegend(ILegend legend,
                  IMapDescriptor mapDescriptor,
                  int dpi,
                  int imageWidth,
                  int imageHeight,
                  IColor backgroundColor,
                  String fileType,
                  String outputFileName)
                  throws IOException,
                         AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

legend - A reference to a com.esri.arcgis.carto.ILegend (in)

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportScaleBar

void exportScaleBar(IScaleBar scalebar,
                    int mapImageWidthPixels,
                    int dpi,
                    int imageWidth,
                    int imageHeight,
                    IColor backgroundColor,
                    String fileType,
                    String outputFileName)
                    throws IOException,
                           AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

scalebar - A reference to a com.esri.arcgis.carto.IScaleBar (in)

mapImageWidthPixels - The mapImageWidthPixels (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportNorthArrow

void exportNorthArrow(INorthArrow arrow,
                      int dpi,
                      int imageWidth,
                      int imageHeight,
                      IColor backgroundColor,
                      String fileType,
                      String outputFileName)
                      throws IOException,
                             AutomationException

Deprecated.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

arrow - A reference to a com.esri.arcgis.carto.INorthArrow (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTOCInfo

IArray getTOCInfo(String mapName,
                  int layerID)
                  throws IOException,
                         AutomationException

Deprecated.

The TOC Information.

Product Availability

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

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMapName

String getDefaultMapName()
                         throws IOException,
                                AutomationException

Deprecated.

The TOC Information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The mapName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureValue

String getFeatureValue(String mapName,
                       int layerID,
                       IFeature feature,
                       String fieldName)
                       throws IOException,
                              AutomationException

Deprecated.

The value of the specified field for the specified feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

fieldName - The fieldName (in)

Returns:

The fieldValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.