com.esri.arcgis.carto
Interface IPageLayout3

All Superinterfaces:

Serializable

All Known Implementing Classes:

PageLayout

public interface IPageLayout3
extends Serializable

Provides access to members that control the Page Layout.

Product Availability

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

Method Summary

void	clearContent() Clears the elements without dismantling them.
void	focusNextMapFrame() Focus the next map.
void	focusPreviousMapFrame() Focus the previous map.
Object	getContentProvider() The object that is currently managing the content of the layout.
ISnapGuides	getHorizontalSnapGuides() The horizontal snapping guides.
IPage	getPage() On-screen representation of the printer page.
IPrinter	getPrinter() The associated printer.
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.
boolean	isDelayEvents() Indicates if the layout stops firing events until the flag is set to false.
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	setContentProviderByRef(Object provider) The object that is currently managing the content of the layout.
void	setDelayEvents(boolean delayEvents) Indicates if the layout stops firing events until the flag is set to false.
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.

Method Detail

getPage

IPage getPage()
              throws IOException,
                     AutomationException

On-screen representation of the printer page.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRulerSettings

IRulerSettings getRulerSettings()
                                throws IOException,
                                       AutomationException

The ruler settings.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IRulerSettings

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapGrid

ISnapGrid getSnapGrid()
                      throws IOException,
                             AutomationException

The snapping grid.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.ISnapGrid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalSnapGuides

ISnapGuides getHorizontalSnapGuides()
                                    throws IOException,
                                           AutomationException

The horizontal snapping guides.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.ISnapGuides

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalSnapGuides

ISnapGuides getVerticalSnapGuides()
                                  throws IOException,
                                         AutomationException

The vertical snapping guides.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.ISnapGuides

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZoomPercent

double getZoomPercent()
                      throws IOException,
                             AutomationException

The current zoom percent. 100 means 1:1. 200 means twice normal size, etc.

Product Availability

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

Returns:

The percent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignToMargins

void setAlignToMargins(boolean alignToMargins)
                       throws IOException,
                              AutomationException

Indicates if graphics will be aligned to the margins or to each other.

Product Availability

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

Parameters:

alignToMargins - The alignToMargins (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAlignToMargins

boolean isAlignToMargins()
                         throws IOException,
                                AutomationException

Indicates if graphics will be aligned to the margins or to each other.

Product Availability

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

Returns:

The alignToMargins

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomToWidth

void zoomToWidth()
                 throws IOException,
                        AutomationException

Fit the width of the page to the screen.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomToWhole

void zoomToWhole()
                 throws IOException,
                        AutomationException

Fit the whole page in the window.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomToPercent

void zoomToPercent(int percent)
                   throws IOException,
                          AutomationException

Magnify the page by a certain percentage. 100 means actual size. 200 means twice normal size, etc.

Product Availability

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

Parameters:

percent - The percent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

focusNextMapFrame

void focusNextMapFrame()
                       throws IOException,
                              AutomationException

Focus the next map.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

focusPreviousMapFrame

void focusPreviousMapFrame()
                           throws IOException,
                                  AutomationException

Focus the previous map.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceMaps

void replaceMaps(IMaps maps)
                 throws 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.

Product Availability

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

Parameters:

maps - A reference to a com.esri.arcgis.carto.IMaps (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContentProviderByRef

void setContentProviderByRef(Object provider)
                             throws IOException,
                                    AutomationException

The object that is currently managing the content of the layout.

Product Availability

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

Parameters:

provider - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentProvider

Object getContentProvider()
                          throws IOException,
                                 AutomationException

The object that is currently managing the content of the layout.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearContent

void clearContent()
                  throws IOException,
                         AutomationException

Clears the elements without dismantling them.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrinter

IPrinter getPrinter()
                    throws IOException,
                           AutomationException

The associated printer.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.output.IPrinter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDelayEvents

boolean isDelayEvents()
                      throws IOException,
                             AutomationException

Indicates if the layout stops firing events until the flag is set to false.

Product Availability

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

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 layout stops firing events until the flag is set to false.

Product Availability

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

Parameters:

delayEvents - The delayEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.