com.esri.arcgis.carto
Interface IPage

All Superinterfaces:
Serializable
All Known Implementing Classes:
Page

public interface IPage
extends Serializable

Provides access to members that control the Page.

Remarks

IPage is the primary interface on the Page object which manages the page on which the page layout is drawn.

Use this interface to access all of the properties of an ArcMap page, including the page’s border, background, background color, orientation, and size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void drawBackground(IDisplay display)
          Draw the page background.
 void drawBorder(IDisplay display)
          Draw the page border.
 void drawPaper(IDisplay display, IColor eraseColor)
          Draw the paper.
 void drawPrintableArea(IDisplay display)
          Draw the printable area.
 IBackground getBackground()
          The page background.
 IColor getBackgroundColor()
          The page color.
 IBorder getBorder()
          The page border.
 void getDeviceBounds(IPrinter printer, short currentPage, double overlap, short resolution, IEnvelope deviceBounds)
          Return the printer page size in device units.
 int getFormID()
          The Page form.
 short getOrientation()
          The Page orientation.
 void getPageBounds(IPrinter printer, short currentPage, double overlap, IEnvelope pageBounds)
          Return the page size in page units.
 int getPageToPrinterMapping()
          The page to printer mapping.
 IEnvelope getPrintableBounds()
          The printable bounds.
 int getUnits()
          The units used for the page and all associated coordinates.
 boolean isDelayEvents()
          Indicates if the page stops firing IPageEvents until the flag is set to false.
 boolean isPrintableAreaVisible()
          Indicates if the printable area is visible.
 boolean isStretchGraphicsWithPage()
          Indicates if graphics should stretch with the page when the page size changes.
 void printerChanged(IPrinter printer)
          Called by PageLayout when printer changes.
 void printerPageCount(IPrinter printer, double overlap, short[] pageCount)
          The number of printer pages spanned by the page.
 void putCustomSize(double width, double height)
          The size of the page in page units.
 void querySize(double[] width, double[] height)
          The size of the page in page units.
 void setBackground(IBackground background)
          The page background.
 void setBackgroundColor(IColor color)
          The page color.
 void setBorder(IBorder border)
          The page border.
 void setDelayEvents(boolean delayEvents)
          Indicates if the page stops firing IPageEvents until the flag is set to false.
 void setFormID(int formID)
          The Page form.
 void setIsPrintableAreaVisible(boolean isPrintableAreaVisible)
          Indicates if the printable area is visible.
 void setOrientation(short orientation)
          The Page orientation.
 void setPageToPrinterMapping(int mode)
          The page to printer mapping.
 void setStretchGraphicsWithPage(boolean stretchGraphicsWithPage)
          Indicates if graphics should stretch with the page when the page size changes.
 void setUnits(int units)
          The units used for the page and all associated coordinates.
 

Method Detail

getFormID

int getFormID()
              throws IOException,
                     AutomationException
The Page form.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFormID

void setFormID(int formID)
               throws IOException,
                      AutomationException
The Page form.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
formID - A com.esri.arcgis.carto.esriPageFormID constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrientation

short getOrientation()
                     throws IOException,
                            AutomationException
The Page orientation. 1 = portrait. 2 = landscape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOrientation

void setOrientation(short orientation)
                    throws IOException,
                           AutomationException
The Page orientation. 1 = portrait. 2 = landscape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
orientation - The orientation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws IOException,
                    AutomationException
The units used for the page and all associated coordinates.

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.

setUnits

void setUnits(int units)
              throws IOException,
                     AutomationException
The units used for the page and all associated coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPrintableBounds

IEnvelope getPrintableBounds()
                             throws IOException,
                                    AutomationException
The printable bounds.

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.

isPrintableAreaVisible

boolean isPrintableAreaVisible()
                               throws IOException,
                                      AutomationException
Indicates if the printable area is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setIsPrintableAreaVisible

void setIsPrintableAreaVisible(boolean isPrintableAreaVisible)
                               throws IOException,
                                      AutomationException
Indicates if the printable area is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
isPrintableAreaVisible - The isPrintableAreaVisible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStretchGraphicsWithPage

boolean isStretchGraphicsWithPage()
                                  throws IOException,
                                         AutomationException
Indicates if graphics should stretch with the page when the page size changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStretchGraphicsWithPage

void setStretchGraphicsWithPage(boolean stretchGraphicsWithPage)
                                throws IOException,
                                       AutomationException
Indicates if graphics should stretch with the page when the page size changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
stretchGraphicsWithPage - The stretchGraphicsWithPage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
The page color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(IColor color)
                        throws IOException,
                               AutomationException
The page color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBorder

IBorder getBorder()
                  throws IOException,
                         AutomationException
The page border.

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

setBorder

void setBorder(IBorder border)
               throws IOException,
                      AutomationException
The page border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBackground

IBackground getBackground()
                          throws IOException,
                                 AutomationException
The page background.

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

setBackground

void setBackground(IBackground background)
                   throws IOException,
                          AutomationException
The page background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isDelayEvents

boolean isDelayEvents()
                      throws IOException,
                             AutomationException
Indicates if the page stops firing IPageEvents until the flag is set to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDelayEvents

void setDelayEvents(boolean delayEvents)
                    throws IOException,
                           AutomationException
Indicates if the page stops firing IPageEvents until the flag is set to false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
delayEvents - The delayEvents (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageToPrinterMapping

int getPageToPrinterMapping()
                            throws IOException,
                                   AutomationException
The page to printer mapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPageToPrinterMapping

void setPageToPrinterMapping(int mode)
                             throws IOException,
                                    AutomationException
The page to printer mapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
mode - A com.esri.arcgis.carto.esriPageToPrinterMapping constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

querySize

void querySize(double[] width,
               double[] height)
               throws IOException,
                      AutomationException
The size of the page in page units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
width - The width (out: use single element array)
height - The height (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putCustomSize

void putCustomSize(double width,
                   double height)
                   throws IOException,
                          AutomationException
The size of the page in page units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
width - The width (in)
height - The height (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

printerPageCount

void printerPageCount(IPrinter printer,
                      double overlap,
                      short[] pageCount)
                      throws IOException,
                             AutomationException
The number of printer pages spanned by the page.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
printer - A reference to a com.esri.arcgis.output.IPrinter (in)
overlap - The overlap (in)
pageCount - The pageCount (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageBounds

void getPageBounds(IPrinter printer,
                   short currentPage,
                   double overlap,
                   IEnvelope pageBounds)
                   throws IOException,
                          AutomationException
Return the page size in page units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
printer - A reference to a com.esri.arcgis.output.IPrinter (in)
currentPage - The currentPage (in)
overlap - The overlap (in)
pageBounds - 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.

getDeviceBounds

void getDeviceBounds(IPrinter printer,
                     short currentPage,
                     double overlap,
                     short resolution,
                     IEnvelope deviceBounds)
                     throws IOException,
                            AutomationException
Return the printer page size in device units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
printer - A reference to a com.esri.arcgis.output.IPrinter (in)
currentPage - The currentPage (in)
overlap - The overlap (in)
resolution - The resolution (in)
deviceBounds - 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.

drawPaper

void drawPaper(IDisplay display,
               IColor eraseColor)
               throws IOException,
                      AutomationException
Draw the paper. EraseColor is the color of the area surrounding the page. Only the area around the page is drawn in order to eliminate flashing. Use EraseColor = 0 to simply draw page.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

drawBackground

void drawBackground(IDisplay display)
                    throws IOException,
                           AutomationException
Draw the page background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

drawPrintableArea

void drawPrintableArea(IDisplay display)
                       throws IOException,
                              AutomationException
Draw the printable area.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

drawBorder

void drawBorder(IDisplay display)
                throws IOException,
                       AutomationException
Draw the page border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

printerChanged

void printerChanged(IPrinter printer)
                    throws IOException,
                           AutomationException
Called by PageLayout when printer changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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