com.esri.arcgis.controls
Interface IPageLayoutControl

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IPageLayoutControl2, IPageLayoutControl3

All Known Implementing Classes:

IPageLayoutControl2Proxy, IPageLayoutControl3Proxy, IPageLayoutControlProxy, PageLayoutBean, PageLayoutControl

public interface IPageLayoutControl
extends java.io.Serializable

COM Interface 'IPageLayoutControl'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the PageLayoutControl.' 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	DISPID__501_GET_NAME
static java.lang.String	DISPID__501_PUT_NAME
static java.lang.String	DISPID__504_GET_NAME
static java.lang.String	DISPID__504_PUT_NAME
static java.lang.String	DISPID__514_GET_NAME
static java.lang.String	DISPID__514_PUT_NAME
static java.lang.String	DISPID__515_GET_NAME
static java.lang.String	DISPID__520_GET_NAME
static java.lang.String	DISPID__520_PUT_NAME
static java.lang.String	DISPID__521_GET_NAME
static java.lang.String	DISPID__521_PUT_NAME
static java.lang.String	DISPID__522_GET_NAME
static java.lang.String	DISPID__522_PUTREF_NAME
static java.lang.String	DISPID__552_NAME
static java.lang.String	DISPID_10_NAME
static java.lang.String	DISPID_11_GET_NAME
static java.lang.String	DISPID_11_PUTREF_NAME
static java.lang.String	DISPID_12_GET_NAME
static java.lang.String	DISPID_12_PUTREF_NAME
static java.lang.String	DISPID_13_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_15_NAME
static java.lang.String	DISPID_16_NAME
static java.lang.String	DISPID_17_NAME
static java.lang.String	DISPID_18_NAME
static java.lang.String	DISPID_19_NAME
static java.lang.String	DISPID_2_GET_NAME
static java.lang.String	DISPID_2_PUTREF_NAME
static java.lang.String	DISPID_20_GET_NAME
static java.lang.String	DISPID_20_PUT_NAME
static java.lang.String	DISPID_21_NAME
static java.lang.String	DISPID_22_NAME
static java.lang.String	DISPID_23_GET_NAME
static java.lang.String	DISPID_24_NAME
static java.lang.String	DISPID_25_NAME
static java.lang.String	DISPID_26_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_3_PUTREF_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_6_PUT_NAME
static java.lang.String	DISPID_7_GET_NAME
static java.lang.String	DISPID_7_PUT_NAME
static java.lang.String	DISPID_8_GET_NAME
static java.lang.String	DISPID_9_GET_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID93840439_2ba9_4dfe_a431_9a13b02bde9e
static int	xxDummy Deprecated. Internal use only

Method Summary

void	aboutBox() Displays a dialog of information about the PageLayoutControl.
void	addElement(IElement pElement, java.lang.Object geometry, java.lang.Object symbology, java.lang.Object name, int zOrder) Adds the supplied element to the PageLayout, with optional geometry, symbolization, name and Z order.
void	centerAt(IPoint centerPoint) Moves the center of the PageLayoutControl to the specified location.
boolean	checkMxFile(java.lang.String fileName) Checks the specified filename to see if it is a map document that can be loaded into the PageLayoutControl.
boolean	esri_isEnabled() Indicates whether the PageLayoutControl can respond to user generated events.
void	esri_setEnabled(boolean pbool) Indicates whether the PageLayoutControl can respond to user generated events.
IElement	findElementByName(java.lang.String name, int occurence) Find the first element with the supplied name, supply an occurrence parameter to find the second, third and so on.
void	fromPagePoint(IPoint pt, int[] x, int[] y) Converts a point on the page (in page units) to device co-ordinates (typically pixels).
IActiveView	getActiveView() The active view of the PageLayout contained by the PageLayoutControl.
int	getAppearance() The appearance of the PageLayoutControl.
int	getBackColor() Background color of the PageLayoutControl.
int	getBorderStyle() The border style of the PageLayoutControl.
ITool	getCurrentTool() Current active tool for the PageLayoutControl.
IEnvelope	getExtent() Current extent of the PageLayout in page units.
IEnvelope	getFullExtent() Rectangular shape that encloses the PageLayout.
IGraphicsContainer	getGraphicsContainer() The graphics container of the PageLayout object contained by the PageLayoutControl.
int	getHWnd() Handle to the window associated with the PageLayoutControl.
Picture	getMouseIcon() Custom mouse icon used if MousePointer is 99.
int	getMousePointer() The mouse pointer displayed over the PageLayoutControl.
IPage	getPage() The Page associated with the PageLayout contained by the PageLayoutControl.
IPageLayout	getPageLayout() The PageLayout contained by the PageLayoutControl.
IPrinter	getPrinter() The printer object used by the PageLayoutControl for printing.
short	getPrinterPageCount(double overlap) The number of printer pages the PageLayout will cover.
ITrackCancel	getTrackCancel() The object used by the PageLayoutControl to check if drawing has been aborted.
boolean	isOleDropEnabled() Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.
void	loadMxFile(java.lang.String fileName, java.lang.Object password) Loads the specified map document into the PageLayout contained by the PageLayoutControl.
IElement	locateFrontElement(double pageX, double pageY, double tolerance) Locates an element at the given page co-ordinates.
void	pan() Tracks the mouse while panning the PageLayoutControl.
void	printPageLayout(short startPage, short endPage, double overlap) Sends the specified range of pages on the printer.
void	refresh(int phase, java.lang.Object layerOrElement, java.lang.Object envelope) Redraws the PageLayout, optionally just redraw specified phases or envelope.
void	setAppearance(int pappearance) The appearance of the PageLayoutControl.
void	setBackColor(int pclr) Background color of the PageLayoutControl.
void	setBorderStyle(int pstyle) The border style of the PageLayoutControl.
void	setCurrentToolByRef(ITool pTool) Current active tool for the PageLayoutControl.
void	setExtent(IEnvelope extent) Current extent of the PageLayout in page units.
void	setFullExtent(IEnvelope fullExtent) Rectangular shape that encloses the PageLayout.
void	setMouseIconByRef(Picture ppMouseIcon) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int ppointer) The mouse pointer displayed over the PageLayoutControl.
void	setOleDropEnabled(boolean value) Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.
void	setPageLayoutByRef(IPageLayout pPageLayout) The PageLayout contained by the PageLayoutControl.
void	setPrinterByRef(IPrinter ppPrinter) The printer object used by the PageLayoutControl for printing.
void	setTrackCancelByRef(ITrackCancel ppTrackCancel) The object used by the PageLayoutControl to check if drawing has been aborted.
IPoint	toPagePoint(int x, int y) Converts device co-ordinates (typically pixels) to a point on the page (in page units).
IEnvelope	trackRectangle() Rubber-bands a rectangle on the PageLayoutControl.
void	zoomToWholePage() Changes the extent of the PageLayout to show a whole page.

Field Detail

IID93840439_2ba9_4dfe_a431_9a13b02bde9e

static final int IID93840439_2ba9_4dfe_a431_9a13b02bde9e

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

DISPID__501_PUT_NAME

static final java.lang.String DISPID__501_PUT_NAME

See Also:

Constant Field Values

DISPID__501_GET_NAME

static final java.lang.String DISPID__501_GET_NAME

See Also:

Constant Field Values

DISPID__504_PUT_NAME

static final java.lang.String DISPID__504_PUT_NAME

See Also:

Constant Field Values

DISPID__504_GET_NAME

static final java.lang.String DISPID__504_GET_NAME

See Also:

Constant Field Values

DISPID__514_PUT_NAME

static final java.lang.String DISPID__514_PUT_NAME

See Also:

Constant Field Values

DISPID__514_GET_NAME

static final java.lang.String DISPID__514_GET_NAME

See Also:

Constant Field Values

DISPID__520_PUT_NAME

static final java.lang.String DISPID__520_PUT_NAME

See Also:

Constant Field Values

DISPID__520_GET_NAME

static final java.lang.String DISPID__520_GET_NAME

See Also:

Constant Field Values

DISPID__521_PUT_NAME

static final java.lang.String DISPID__521_PUT_NAME

See Also:

Constant Field Values

DISPID__521_GET_NAME

static final java.lang.String DISPID__521_GET_NAME

See Also:

Constant Field Values

DISPID__522_PUTREF_NAME

static final java.lang.String DISPID__522_PUTREF_NAME

See Also:

Constant Field Values

DISPID__522_GET_NAME

static final java.lang.String DISPID__522_GET_NAME

See Also:

Constant Field Values

DISPID__515_GET_NAME

static final java.lang.String DISPID__515_GET_NAME

See Also:

Constant Field Values

DISPID__552_NAME

static final java.lang.String DISPID__552_NAME

See Also:

Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME

See Also:

Constant Field Values

DISPID_2_PUTREF_NAME

static final java.lang.String DISPID_2_PUTREF_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_3_PUTREF_NAME

static final java.lang.String DISPID_3_PUTREF_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_6_PUT_NAME

static final java.lang.String DISPID_6_PUT_NAME

See Also:

Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_NAME

See Also:

Constant Field Values

DISPID_7_PUT_NAME

static final java.lang.String DISPID_7_PUT_NAME

See Also:

Constant Field Values

DISPID_8_GET_NAME

static final java.lang.String DISPID_8_GET_NAME

See Also:

Constant Field Values

DISPID_9_GET_NAME

static final java.lang.String DISPID_9_GET_NAME

See Also:

Constant Field Values

DISPID_10_NAME

static final java.lang.String DISPID_10_NAME

See Also:

Constant Field Values

DISPID_11_GET_NAME

static final java.lang.String DISPID_11_GET_NAME

See Also:

Constant Field Values

DISPID_11_PUTREF_NAME

static final java.lang.String DISPID_11_PUTREF_NAME

See Also:

Constant Field Values

DISPID_12_GET_NAME

static final java.lang.String DISPID_12_GET_NAME

See Also:

Constant Field Values

DISPID_12_PUTREF_NAME

static final java.lang.String DISPID_12_PUTREF_NAME

See Also:

Constant Field Values

DISPID_13_NAME

static final java.lang.String DISPID_13_NAME

See Also:

Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_15_NAME

static final java.lang.String DISPID_15_NAME

See Also:

Constant Field Values

DISPID_16_NAME

static final java.lang.String DISPID_16_NAME

See Also:

Constant Field Values

DISPID_17_NAME

static final java.lang.String DISPID_17_NAME

See Also:

Constant Field Values

DISPID_18_NAME

static final java.lang.String DISPID_18_NAME

See Also:

Constant Field Values

DISPID_19_NAME

static final java.lang.String DISPID_19_NAME

See Also:

Constant Field Values

DISPID_20_GET_NAME

static final java.lang.String DISPID_20_GET_NAME

See Also:

Constant Field Values

DISPID_20_PUT_NAME

static final java.lang.String DISPID_20_PUT_NAME

See Also:

Constant Field Values

DISPID_21_NAME

static final java.lang.String DISPID_21_NAME

See Also:

Constant Field Values

DISPID_22_NAME

static final java.lang.String DISPID_22_NAME

See Also:

Constant Field Values

DISPID_23_GET_NAME

static final java.lang.String DISPID_23_GET_NAME

See Also:

Constant Field Values

DISPID_24_NAME

static final java.lang.String DISPID_24_NAME

See Also:

Constant Field Values

DISPID_25_NAME

static final java.lang.String DISPID_25_NAME

See Also:

Constant Field Values

DISPID_26_NAME

static final java.lang.String DISPID_26_NAME

See Also:

Constant Field Values

Method Detail

setBackColor

void setBackColor(int pclr)
                  throws java.io.IOException,
                         AutomationException

Background color of the PageLayoutControl.

Parameters:

pclr - The pclr (A COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackColor

int getBackColor()
                 throws java.io.IOException,
                        AutomationException

Background color of the PageLayoutControl.

Returns:

The pclr (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorderStyle

void setBorderStyle(int pstyle)
                    throws java.io.IOException,
                           AutomationException

The border style of the PageLayoutControl.

Parameters:

pstyle - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBorderStyle

int getBorderStyle()
                   throws java.io.IOException,
                          AutomationException

The border style of the PageLayoutControl.

Returns:

A com.esri.arcgis.controls.esriControlsBorderStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

void esri_setEnabled(boolean pbool)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the PageLayoutControl can respond to user generated events.

Parameters:

pbool - The pbool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

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

Indicates whether the PageLayoutControl can respond to user generated events.

Returns:

The pbool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAppearance

void setAppearance(int pappearance)
                   throws java.io.IOException,
                          AutomationException

The appearance of the PageLayoutControl.

Parameters:

pappearance - A com.esri.arcgis.controls.esriControlsAppearance constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAppearance

int getAppearance()
                  throws java.io.IOException,
                         AutomationException

The appearance of the PageLayoutControl.

Returns:

A com.esri.arcgis.controls.esriControlsAppearance constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMousePointer

void setMousePointer(int ppointer)
                     throws java.io.IOException,
                            AutomationException

The mouse pointer displayed over the PageLayoutControl.

Parameters:

ppointer - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMousePointer

int getMousePointer()
                    throws java.io.IOException,
                           AutomationException

The mouse pointer displayed over the PageLayoutControl.

Returns:

A com.esri.arcgis.controls.esriControlsMousePointer constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

void setMouseIconByRef(Picture ppMouseIcon)
                       throws java.io.IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

Parameters:

ppMouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMouseIcon

Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException

Custom mouse icon used if MousePointer is 99.

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws java.io.IOException,
                   AutomationException

Handle to the window associated with the PageLayoutControl.

Returns:

The hWnd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

aboutBox

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

Displays a dialog of information about the PageLayoutControl.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentTool

ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException

Current active tool for the PageLayoutControl. Set to nothing to clear the tool.

Returns:

A reference to a com.esri.arcgis.systemUI.ITool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

void setCurrentToolByRef(ITool pTool)
                         throws java.io.IOException,
                                AutomationException

Current active tool for the PageLayoutControl. Set to nothing to clear the tool.

Parameters:

pTool - A reference to a com.esri.arcgis.systemUI.ITool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageLayout

IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

The PageLayout contained by the PageLayoutControl.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageLayoutByRef

void setPageLayoutByRef(IPageLayout pPageLayout)
                        throws java.io.IOException,
                               AutomationException

The PageLayout contained by the PageLayoutControl.

Parameters:

pPageLayout - A reference to a com.esri.arcgis.carto.IPageLayout (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

The active view of the PageLayout contained by the PageLayoutControl.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

Current extent of the PageLayout in page units.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException

Current extent of the PageLayout in page units.

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullExtent

IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException

Rectangular shape that encloses the PageLayout.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFullExtent

void setFullExtent(IEnvelope fullExtent)
                   throws java.io.IOException,
                          AutomationException

Rectangular shape that encloses the PageLayout.

Parameters:

fullExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPage

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

The Page associated with the PageLayout contained by the PageLayoutControl.

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.

getGraphicsContainer

IGraphicsContainer getGraphicsContainer()
                                        throws java.io.IOException,
                                               AutomationException

The graphics container of the PageLayout object contained by the PageLayoutControl.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

printPageLayout

void printPageLayout(short startPage,
                     short endPage,
                     double overlap)
                     throws java.io.IOException,
                            AutomationException

Sends the specified range of pages on the printer.

Parameters:

startPage - The startPage (in, optional, pass 1 if not required)

endPage - The endPage (in, optional, pass 0 if not required)

overlap - The overlap (in, optional, pass 0 if not required)

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 printer object used by the PageLayoutControl for printing.

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.

setPrinterByRef

void setPrinterByRef(IPrinter ppPrinter)
                     throws java.io.IOException,
                            AutomationException

The printer object used by the PageLayoutControl for printing.

Parameters:

ppPrinter - A reference to a com.esri.arcgis.output.IPrinter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackCancel

ITrackCancel getTrackCancel()
                            throws java.io.IOException,
                                   AutomationException

The object used by the PageLayoutControl to check if drawing has been aborted.

Returns:

A reference to a com.esri.arcgis.system.ITrackCancel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                         throws java.io.IOException,
                                AutomationException

The object used by the PageLayoutControl to check if drawing has been aborted.

Parameters:

ppTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

pan

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

Tracks the mouse while panning the PageLayoutControl.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

centerAt

void centerAt(IPoint centerPoint)
              throws java.io.IOException,
                     AutomationException

Moves the center of the PageLayoutControl to the specified location.

Parameters:

centerPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

trackRectangle

IEnvelope trackRectangle()
                         throws java.io.IOException,
                                AutomationException

Rubber-bands a rectangle on the PageLayoutControl.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addElement

void addElement(IElement pElement,
                java.lang.Object geometry,
                java.lang.Object symbology,
                java.lang.Object name,
                int zOrder)
                throws java.io.IOException,
                       AutomationException

Adds the supplied element to the PageLayout, with optional geometry, symbolization, name and Z order.

Parameters:

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

geometry - A Variant (in, optional, pass null if not required)

symbology - A Variant (in, optional, pass null if not required)

name - A Variant (in, optional, pass null if not required)

zOrder - The zOrder (in, optional, pass 0 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

locateFrontElement

IElement locateFrontElement(double pageX,
                            double pageY,
                            double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Locates an element at the given page co-ordinates. If more than one element is at the location the element nearest the front is returned.

Parameters:

pageX - The pageX (in)

pageY - The pageY (in)

tolerance - The tolerance (in, optional, pass 0 if not required)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findElementByName

IElement findElementByName(java.lang.String name,
                           int occurence)
                           throws java.io.IOException,
                                  AutomationException

Find the first element with the supplied name, supply an occurrence parameter to find the second, third and so on.

Parameters:

name - The name (in)

occurence - The occurence (in, optional, pass 1 if not required)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadMxFile

void loadMxFile(java.lang.String fileName,
                java.lang.Object password)
                throws java.io.IOException,
                       AutomationException

Loads the specified map document into the PageLayout contained by the PageLayoutControl.

Parameters:

fileName - The fileName (in)

password - A Variant (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOleDropEnabled

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

Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOleDropEnabled

void setOleDropEnabled(boolean value)
                       throws java.io.IOException,
                              AutomationException

Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkMxFile

boolean checkMxFile(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException

Checks the specified filename to see if it is a map document that can be loaded into the PageLayoutControl.

Parameters:

fileName - The fileName (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

zoomToWholePage

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

Changes the extent of the PageLayout to show a whole page.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrinterPageCount

short getPrinterPageCount(double overlap)
                          throws java.io.IOException,
                                 AutomationException

The number of printer pages the PageLayout will cover.

Parameters:

overlap - The overlap (in, optional, pass 0 if not required)

Returns:

The pageCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(int phase,
             java.lang.Object layerOrElement,
             java.lang.Object envelope)
             throws java.io.IOException,
                    AutomationException

Redraws the PageLayout, optionally just redraw specified phases or envelope.

Parameters:

phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in, optional, pass 65535 if not required)

layerOrElement - A Variant (in, optional, pass null if not required)

envelope - A Variant (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fromPagePoint

void fromPagePoint(IPoint pt,
                   int[] x,
                   int[] y)
                   throws java.io.IOException,
                          AutomationException

Converts a point on the page (in page units) to device co-ordinates (typically pixels).

Parameters:

pt - A reference to a com.esri.arcgis.geometry.IPoint (in)

x - The x (in/out: use single element array)

y - The y (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toPagePoint

IPoint toPagePoint(int x,
                   int y)
                   throws java.io.IOException,
                          AutomationException

Converts device co-ordinates (typically pixels) to a point on the page (in page units).

Parameters:

x - The x (in)

y - The y (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.