com.esri.arcgis.carto
Interface IMxdServer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMxdServerProxy, MxdServer

public interface IMxdServer
extends java.io.Serializable

COM Interface 'IMxdServer'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that support opening a map document and generating images of it.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID_0_NAME
static java.lang.String	DISPID_1_NAME
static java.lang.String	DISPID_10_NAME
static java.lang.String	DISPID_11_NAME
static java.lang.String	DISPID_12_NAME
static java.lang.String	DISPID_13_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_15_GET_NAME
static java.lang.String	DISPID_16_GET_NAME
static java.lang.String	DISPID_17_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_7_NAME
static java.lang.String	DISPID_8_NAME
static java.lang.String	DISPID_9_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IIDbd2e03fc_a244_46af_93ed_b522a090de89
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IIDbd2e03fc_a244_46af_93ed_b522a090de89

static final int IIDbd2e03fc_a244_46af_93ed_b522a090de89

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_0_NAME

static final java.lang.String DISPID_0_NAME

See Also:

Constant Field Values

DISPID_1_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_7_NAME

static final java.lang.String DISPID_7_NAME

See Also:

Constant Field Values

DISPID_8_NAME

static final java.lang.String DISPID_8_NAME

See Also:

Constant Field Values

DISPID_9_NAME

static final java.lang.String DISPID_9_NAME

See Also:

Constant Field Values

DISPID_10_NAME

static final java.lang.String DISPID_10_NAME

See Also:

Constant Field Values

DISPID_11_NAME

static final java.lang.String DISPID_11_NAME

See Also:

Constant Field Values

DISPID_12_NAME

static final java.lang.String DISPID_12_NAME

See Also:

Constant Field Values

DISPID_13_NAME

static final java.lang.String DISPID_13_NAME

See Also:

Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_15_GET_NAME

static final java.lang.String DISPID_15_GET_NAME

See Also:

Constant Field Values

DISPID_16_GET_NAME

static final java.lang.String DISPID_16_GET_NAME

See Also:

Constant Field Values

DISPID_17_NAME

static final java.lang.String DISPID_17_NAME

See Also:

Constant Field Values

Method Detail

start

void start(java.lang.String mxdPath)
           throws java.io.IOException,
                  AutomationException

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.

Parameters:

mxdPath - The mxdPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startWithData

void startWithData(IDataset pDataset)
                   throws java.io.IOException,
                          AutomationException

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.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

void stop()
          throws java.io.IOException,
                 AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapDescriptors

IArray getMapDescriptors()
                         throws java.io.IOException,
                                AutomationException

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.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptors

IArray getLayerDescriptors(java.lang.String mapName)
                           throws java.io.IOException,
                                  AutomationException

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.

Parameters:

mapName - The mapName (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBookmarks

IEnumSpatialBookmark getBookmarks(java.lang.String mapName)
                                  throws java.io.IOException,
                                         AutomationException

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

Parameters:

mapName - The mapName (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

Picture getThumbnail()
                     throws java.io.IOException,
                            AutomationException

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.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapPicture

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

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.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapBitmapHandle

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

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.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

releaseBitmapHandle

void releaseBitmapHandle(int hBmp)
                         throws java.io.IOException,
                                AutomationException

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

Parameters:

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

Throws:

java.io.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,
                         java.lang.String fileType,
                         java.lang.String outputFileName)
                         throws java.io.IOException,
                                AutomationException

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

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:

java.io.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,
                       java.lang.String fileType,
                       java.lang.String outputFileName)
                       throws java.io.IOException,
                              AutomationException

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

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:

java.io.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,
                  java.lang.String fileType,
                  java.lang.String outputFileName)
                  throws java.io.IOException,
                         AutomationException

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.

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:

java.io.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,
                    java.lang.String fileType,
                    java.lang.String outputFileName)
                    throws java.io.IOException,
                           AutomationException

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.

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:

java.io.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,
                      java.lang.String fileType,
                      java.lang.String outputFileName)
                      throws java.io.IOException,
                             AutomationException

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.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTOCInfo

IArray getTOCInfo(java.lang.String mapName,
                  int layerID)
                  throws java.io.IOException,
                         AutomationException

The TOC Information.

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMapName

java.lang.String getDefaultMapName()
                                   throws java.io.IOException,
                                          AutomationException

The TOC Information.

Returns:

The mapName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureValue

java.lang.String getFeatureValue(java.lang.String mapName,
                                 int layerID,
                                 IFeature feature,
                                 java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException

The value of the specified field for the specified feature.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.