com.esri.arcgis.carto
Interface IPageLayout3

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IPageLayout3Proxy, PageLayout

public interface IPageLayout3
extends java.io.Serializable

COM Interface 'IPageLayout3'. 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	IIDdbb71b6a_db4e_4780_ae6f_39ea7a4a075f
static int	xxDummy Deprecated. Internal use only

Method Summary

void	clearContent() Clears the elements without dismantling them.
void	focusNextMapFrame() Focus the next map.
void	focusPreviousMapFrame() Focus the previous map.
java.lang.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(java.lang.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.

Field Detail

IIDdbb71b6a_db4e_4780_ae6f_39ea7a4a075f

static final int IIDdbb71b6a_db4e_4780_ae6f_39ea7a4a075f

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

On-screen representation of the printer 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.

setContentProviderByRef

void setContentProviderByRef(java.lang.Object provider)
                             throws java.io.IOException,
                                    AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentProvider

java.lang.Object getContentProvider()
                                    throws java.io.IOException,
                                           AutomationException

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

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearContent

void clearContent()
                  throws java.io.IOException,
                         AutomationException

Clears the elements without dismantling them.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrinter

IPrinter getPrinter()
                    throws java.io.IOException,
                           AutomationException

The associated printer.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDelayEvents

boolean isDelayEvents()
                      throws java.io.IOException,
                             AutomationException

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

Returns:

The delayEvents

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDelayEvents

void setDelayEvents(boolean delayEvents)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

delayEvents - The delayEvents (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.