com.esri.arcgis.carto
Interface ILayoutImage

All Superinterfaces:

IImageResult, Serializable

All Known Implementing Classes:

LayoutImage

public interface ILayoutImage
extends IImageResult, Serializable

Provides access to the Layout Image Interface.

Remarks

The ILayoutImage interface inherits all IImageResult properties.

When To Use

Use ILayoutImage to access properties of an ExportLayout result.

Product Availability

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

Method Summary

IEnvelope	getExtent() The extent of the page that is fitted to the height and width of the generated image.
IMapImages	getMapImages() A collection of MapImage objects contained in the layout.

Methods inherited from interface com.esri.arcgis.carto.IImageResult

getHeight, getMimeData, getReferenceDPI, getURL, getWidth

Method Detail

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the page that is fitted to the height and width of the generated 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.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapImages

IMapImages getMapImages()
                        throws IOException,
                               AutomationException

A collection of MapImage objects contained in the layout. There will be one MapImage object returned for each data frame.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.