com.esri.arcgis.carto
Interface IImageDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

ImageDescription

public interface IImageDescription
extends Serializable

Provides access to the Image Description Interface.

When To Use

Use IImageDescription when creating MapServer output images using ExportMapImage and GetLegendInfo on IMapServer2 and the following methods on IMapServerLayout: ExportLayout, ExportLegend, ExportNorthArrow and ExportScaleBar.

Product Availability

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

Method Summary

IImageDisplay	getDisplay() The display characteristics of the image to be generated.
IImageType	getType() The type of image to be generated.
void	setDisplay(IImageDisplay imgDisplay) The display characteristics of the image to be generated.
void	setType(IImageType imgType) The type of image to be generated.

Method Detail

getType

IImageType getType()
                   throws IOException,
                          AutomationException

The type of image to be generated.

Remarks

Type includes the format and the return type (URL or Mime data) of the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

void setType(IImageType imgType)
             throws IOException,
                    AutomationException

The type of image to be generated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

imgType - A reference to a com.esri.arcgis.carto.IImageType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplay

IImageDisplay getDisplay()
                         throws IOException,
                                AutomationException

The display characteristics of the image to be generated.

Remarks

Display includes the size and the device resolution of the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplay

void setDisplay(IImageDisplay imgDisplay)
                throws IOException,
                       AutomationException

The display characteristics of the image to be generated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

imgDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.