com.esri.arcgis.carto
Interface IPageLayout

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IPageLayoutProxy, PageLayout

public interface IPageLayout
extends java.io.Serializable

COM Interface 'IPageLayout'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the Page Layout.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDdd94d76a_836d_11d0_87ec_080009ec732a
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void focusNextMapFrame()
          Focus the next map.
 void focusPreviousMapFrame()
          Focus the previous map.
 ISnapGuides getHorizontalSnapGuides()
          The horizontal snapping guides.
 IPage getPage()
          The page.
 IRulerSettings getRulerSettings()
          The ruler settings.
 ISnapGrid getSnapGrid()
          The snapping grid.
 ISnapGuides getVerticalSnapGuides()
          The vertical snapping guides.
 double getZoomPercent()
          The current zoom percent.
 boolean isAlignToMargins()
          Indicates if graphics will be aligned to the margins or to each other.
 void replaceMaps(IMaps maps)
          Replace the maps in the data frames with the specified maps.
 void setAlignToMargins(boolean alignToMargins)
          Indicates if graphics will be aligned to the margins or to each other.
 void zoomToPercent(int percent)
          Magnify the page by a certain percentage.
 void zoomToWhole()
          Fit the whole page in the window.
 void zoomToWidth()
          Fit the width of the page to the screen.
 

Field Detail

IIDdd94d76a_836d_11d0_87ec_080009ec732a

static final int IIDdd94d76a_836d_11d0_87ec_080009ec732a
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getPage

IPage getPage()
              throws java.io.IOException,
                     AutomationException
The page.

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

getRulerSettings

IRulerSettings getRulerSettings()
                                throws java.io.IOException,
                                       AutomationException
The ruler settings.

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

getSnapGrid

ISnapGrid getSnapGrid()
                      throws java.io.IOException,
                             AutomationException
The snapping grid.

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

getHorizontalSnapGuides

ISnapGuides getHorizontalSnapGuides()
                                    throws java.io.IOException,
                                           AutomationException
The horizontal snapping guides.

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

getVerticalSnapGuides

ISnapGuides getVerticalSnapGuides()
                                  throws java.io.IOException,
                                         AutomationException
The vertical snapping guides.

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

getZoomPercent

double getZoomPercent()
                      throws java.io.IOException,
                             AutomationException
The current zoom percent. 100 means 1:1. 200 means twice normal size, etc.

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

setAlignToMargins

void setAlignToMargins(boolean alignToMargins)
                       throws java.io.IOException,
                              AutomationException
Indicates if graphics will be aligned to the margins or to each other.

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

isAlignToMargins

boolean isAlignToMargins()
                         throws java.io.IOException,
                                AutomationException
Indicates if graphics will be aligned to the margins or to each other.

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

zoomToWidth

void zoomToWidth()
                 throws java.io.IOException,
                        AutomationException
Fit the width of the page to the screen.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomToWhole

void zoomToWhole()
                 throws java.io.IOException,
                        AutomationException
Fit the whole page in the window.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomToPercent

void zoomToPercent(int percent)
                   throws java.io.IOException,
                          AutomationException
Magnify the page by a certain percentage. 100 means actual size. 200 means twice normal size, etc.

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

focusNextMapFrame

void focusNextMapFrame()
                       throws java.io.IOException,
                              AutomationException
Focus the next map.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

focusPreviousMapFrame

void focusPreviousMapFrame()
                           throws java.io.IOException,
                                  AutomationException
Focus the previous map.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceMaps

void replaceMaps(IMaps maps)
                 throws java.io.IOException,
                        AutomationException
Replace the maps in the data frames with the specified maps. If there are more maps than frames, new frames are created. If there are fewer frames than maps, extra frames are cleared.

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