com.esri.arcgis.carto
Interface IMapFrameDescription

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapFrameDescription

public interface IMapFrameDescription
extends Serializable

Provides access to the available properties of a map frame description object.

Remarks

The ExportLayout method on IMapServerLayout includes an input parameter for the layout page description (PageDescription). The page description consists of a collection of MapFrameDescription objects. These objects provide access to the MapDescription and PageLocation of a particular map frame.

When To Use

Use IMapFrameDescription when exporting an existing map layout using ExportLayout on IMapServerLayout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IMapDescription getMapDescription()
          The map description for the map contained in the frame.
 IEnvelope getPageLocation()
          The extent of the map frame on the page.
 void setMapDescriptionByRef(IMapDescription mapDesc)
          The map description for the map contained in the frame.
 

Method Detail

getPageLocation

IEnvelope getPageLocation()
                          throws IOException,
                                 AutomationException
The extent of the map frame on the page.

Remarks

Use PageLocation when exporting an existing map layout using ExportLayout on IMapServerLayout.

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.

getMapDescription

IMapDescription getMapDescription()
                                  throws IOException,
                                         AutomationException
The map description for the map contained in the frame.

Remarks

Use MapDescription when exporting an existing map layout using ExportLayout on IMapServerLayout.

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.IMapDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapDescriptionByRef

void setMapDescriptionByRef(IMapDescription mapDesc)
                            throws IOException,
                                   AutomationException
The map description for the map contained in the frame.

Product Availability

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

Parameters:
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.