com.esri.arcgis.carto
Interface IPageDescription

All Superinterfaces:
Serializable
All Known Implementing Classes:
PageDescription

public interface IPageDescription
extends Serializable

Provides access to the available properties of a page description object.

Remarks

PageDescription is an input parameter for the ExportLayout method on IMapServerLayout. The page description consists of a collection of MapFrameDescription objects. A MapFrameDescription holds the location of the map on the page layout and serves as a container for the MapDescription. A PageDescription also holds information about the size of the layout, Height and Width, and the page Units .

You can place CustomGraphics on the layout page. You can also specify an Extent of the layout page, in page units, in order to export a section of the layout.

When To Use

Use IPageDescription 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
 IGraphicElements getCustomGraphics()
          Custom graphics on the page.
 IEnvelope getExtent()
          The current extent of the page.
 double getHeight()
          The height of the page.
 IMapFrameDescriptions getMapFrames()
          Descriptions for the map frames on the page.
 int getUnits()
          The page units.
 double getWidth()
          The width of the page.
 void setCustomGraphics(IGraphicElements elements)
          Custom graphics on the page.
 void setExtent(IEnvelope pageExtent)
          The current extent of the page.
 

Method Detail

getHeight

double getHeight()
                 throws IOException,
                        AutomationException
The height of the page.

Remarks

The height is in page units (e.g. inches, centimeters...).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pageHeight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

double getWidth()
                throws IOException,
                       AutomationException
The width of the page.

Remarks

The width is in page units (e.g. inches, centimeters...).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pageWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws IOException,
                    AutomationException
The page units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The current extent of the page.

Remarks

Use Extent to export a part of the layout page. The extent is in page units (e.g. inches, centimeters...). It is important to note that the default value for this extent property is equal to the full extent of the original page layout. It does not equal the state of layout extent in the Active View before saving the map document (for example, zooming into the page layout before saving the map).

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.

setExtent

void setExtent(IEnvelope pageExtent)
               throws IOException,
                      AutomationException
The current extent of the page.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCustomGraphics

IGraphicElements getCustomGraphics()
                                   throws IOException,
                                          AutomationException
Custom graphics on the page.

Remarks

Use CustomGraphics to add dynamic text or graphics to the exported layout. One common use of CustomGraphics is to add a customizable, dynamic title to each result of an ExportLayout request.

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

setCustomGraphics

void setCustomGraphics(IGraphicElements elements)
                       throws IOException,
                              AutomationException
Custom graphics on the page.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMapFrames

IMapFrameDescriptions getMapFrames()
                                   throws IOException,
                                          AutomationException
Descriptions for the map frames on the page.

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