com.esri.arcgis.controls
Interface IARPageLayout

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ARPageLayout, IARPageLayoutProxy

public interface IARPageLayout
extends java.io.Serializable

COM Interface 'IARPageLayout'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members that control the ARPageLayout.' 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_1_NAME
static java.lang.String	DISPID_10_NAME
static java.lang.String	DISPID_11_NAME
static java.lang.String	DISPID_12_GET_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_GET_NAME
static java.lang.String	DISPID_19_GET_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_20_NAME
static java.lang.String	DISPID_21_GET_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_GET_NAME
static java.lang.String	DISPID_26_GET_NAME
static java.lang.String	DISPID_26_PUT_NAME
static java.lang.String	DISPID_27_GET_NAME
static java.lang.String	DISPID_27_PUT_NAME
static java.lang.String	DISPID_28_GET_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_5_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_8_NAME
static java.lang.String	DISPID_9_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IIDd1fd0345_ef40_4ff9_a7b9_c6db6f4e8717
static int	xxDummy Deprecated. Internal use only

Method Summary

void	centerAt(double xCoord, double yCoord) Moves the center of the page layout to the specified point.
IARMap	getARMap(int index) The map at the specified index.
int	getARMapCount() The number of maps in the page layout's map collection.
java.lang.Object	getCustomProperty() A property to associate data with an object.
void	getExtent(double[] xMin, double[] yMin, double[] xMax, double[] yMax) The visible extent of the page layout.
IARMap	getFocusARMap() The current focus map that the current tool acts upon.
double	getHeight() The height of the page.
java.lang.Object	getInternalObject() The internal ArcObjects IPageLayout object.
int	getMapExtentType(IARMap pMap) The extent type of the specified map.
int	getPageUnits() The units of the page and all associated coordinates.
java.lang.String	getTitle() The title in the page layout.
double	getWidth() The width of the page.
double	getZoomPercent() The zoom percent (100 means 1:1, 200 means twice the normal size).
IARMap	hitTestMap(int x, int y) Returns the first map present in the page layout at the specified coordinates.
boolean	isCanRedoExtent() Indicates if there is a page layout extent that can be redone.
boolean	isCanUndoExtent() Indicates if there is a page layout extent that can be undone.
boolean	isHasTitle() Indicates if the page layout has a title that can be changed.
void	pan(int direction, double screenPercentage) Pans the page layout by a factor in a specified direction.
void	redoExtent() Redo the next page layout extent in the stack.
void	refresh(boolean refreshNow) Redraws the page layout display area.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with an object.
void	setExtent(double xMin, double yMin, double xMax, double yMax) Sets the visible extent of the page layout.
void	setFocusARMapByRef(IARMap ppARMap) The current focus map that the current tool acts upon.
void	setPageUnits(int units) The units of the page and all associated coordinates.
void	setTitle(java.lang.String currentTitle) The title in the page layout.
void	toPagePoint(int x, int y, double[] xCoord, double[] yCoord) Converts a point in device coordinates (typically pixels) to coordinates in page units.
void	undoExtent() Undo to the previous page layout extent in the stack.
void	zoomIn(double factor) Zooms in on the page layout by a factor.
void	zoomOut(double factor) Zooms out on the page layout by a factor.
void	zoomToPercent(int percent) Magnifies the page by a percentage (100 means actual size, 200 means twice the normal size).
void	zoomToWholePage() Zooms to the whole page.
void	zoomToWidth() Fits the width of the page into the page layout display area.

Field Detail

IIDd1fd0345_ef40_4ff9_a7b9_c6db6f4e8717

static final int IIDd1fd0345_ef40_4ff9_a7b9_c6db6f4e8717

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_1_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_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_3_GET_NAME

static final java.lang.String DISPID_3_GET_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_5_GET_NAME

static final java.lang.String DISPID_5_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_6_GET_NAME

static final java.lang.String DISPID_6_GET_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_8_NAME

static final java.lang.String DISPID_8_NAME

See Also:

Constant Field Values

DISPID_9_NAME

static final java.lang.String DISPID_9_NAME

See Also:

Constant Field Values

DISPID_10_NAME

static final java.lang.String DISPID_10_NAME

See Also:

Constant Field Values

DISPID_11_NAME

static final java.lang.String DISPID_11_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_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_GET_NAME

static final java.lang.String DISPID_18_GET_NAME

See Also:

Constant Field Values

DISPID_19_GET_NAME

static final java.lang.String DISPID_19_GET_NAME

See Also:

Constant Field Values

DISPID_20_NAME

static final java.lang.String DISPID_20_NAME

See Also:

Constant Field Values

DISPID_21_GET_NAME

static final java.lang.String DISPID_21_GET_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_GET_NAME

static final java.lang.String DISPID_25_GET_NAME

See Also:

Constant Field Values

DISPID_26_GET_NAME

static final java.lang.String DISPID_26_GET_NAME

See Also:

Constant Field Values

DISPID_26_PUT_NAME

static final java.lang.String DISPID_26_PUT_NAME

See Also:

Constant Field Values

DISPID_27_PUT_NAME

static final java.lang.String DISPID_27_PUT_NAME

See Also:

Constant Field Values

DISPID_27_GET_NAME

static final java.lang.String DISPID_27_GET_NAME

See Also:

Constant Field Values

DISPID_28_GET_NAME

static final java.lang.String DISPID_28_GET_NAME

See Also:

Constant Field Values

Method Detail

setExtent

void setExtent(double xMin,
               double yMin,
               double xMax,
               double yMax)
               throws java.io.IOException,
                      AutomationException

Sets the visible extent of the page layout.

Parameters:

xMin - The xMin (in)

yMin - The yMin (in)

xMax - The xMax (in)

yMax - The yMax (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

void getExtent(double[] xMin,
               double[] yMin,
               double[] xMax,
               double[] yMax)
               throws java.io.IOException,
                      AutomationException

The visible extent of the page layout.

Parameters:

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

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFocusARMapByRef

void setFocusARMapByRef(IARMap ppARMap)
                        throws java.io.IOException,
                               AutomationException

The current focus map that the current tool acts upon.

Parameters:

ppARMap - A reference to a com.esri.arcgis.controls.IARMap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFocusARMap

IARMap getFocusARMap()
                     throws java.io.IOException,
                            AutomationException

The current focus map that the current tool acts upon.

Returns:

A reference to a com.esri.arcgis.controls.IARMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getARMapCount

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

The number of maps in the page layout's map collection.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getARMap

IARMap getARMap(int index)
                throws java.io.IOException,
                       AutomationException

The map at the specified index.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.controls.IARMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageUnits

void setPageUnits(int units)
                  throws java.io.IOException,
                         AutomationException

The units of the page and all associated coordinates.

Parameters:

units - A com.esri.arcgis.controls.esriARUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageUnits

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

The units of the page and all associated coordinates.

Returns:

A com.esri.arcgis.controls.esriARUnits constant

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 zoom percent (100 means 1:1, 200 means twice the normal size).

Returns:

The percent

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

Magnifies the page by a percentage (100 means actual size, 200 means twice the normal size).

Parameters:

percent - The percent (in)

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

Zooms to the whole page.

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

Fits the width of the page into the page layout display area.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(boolean refreshNow)
             throws java.io.IOException,
                    AutomationException

Redraws the page layout display area.

Parameters:

refreshNow - The refreshNow (in, optional, pass false if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapExtentType

int getMapExtentType(IARMap pMap)
                     throws java.io.IOException,
                            AutomationException

The extent type of the specified map.

Parameters:

pMap - A reference to a com.esri.arcgis.controls.IARMap (in)

Returns:

A com.esri.arcgis.controls.esriARExtentType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hitTestMap

IARMap hitTestMap(int x,
                  int y)
                  throws java.io.IOException,
                         AutomationException

Returns the first map present in the page layout at the specified coordinates. If there isn't a map or the coordinates are not over a map, nothing will be returned.

Parameters:

x - The x (in)

y - The y (in)

Returns:

A reference to a com.esri.arcgis.controls.IARMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

zoomIn

void zoomIn(double factor)
            throws java.io.IOException,
                   AutomationException

Zooms in on the page layout by a factor.

Parameters:

factor - The factor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

zoomOut

void zoomOut(double factor)
             throws java.io.IOException,
                    AutomationException

Zooms out on the page layout by a factor.

Parameters:

factor - The factor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

pan

void pan(int direction,
         double screenPercentage)
         throws java.io.IOException,
                AutomationException

Pans the page layout by a factor in a specified direction.

Parameters:

direction - A com.esri.arcgis.controls.esriARDirection constant (in)

screenPercentage - The screenPercentage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

centerAt

void centerAt(double xCoord,
              double yCoord)
              throws java.io.IOException,
                     AutomationException

Moves the center of the page layout to the specified point.

Parameters:

xCoord - The xCoord (in)

yCoord - The yCoord (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

double getWidth()
                throws java.io.IOException,
                       AutomationException

The width of the page.

Returns:

The dWidth

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

double getHeight()
                 throws java.io.IOException,
                        AutomationException

The height of the page.

Returns:

The dHeight

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toPagePoint

void toPagePoint(int x,
                 int y,
                 double[] xCoord,
                 double[] yCoord)
                 throws java.io.IOException,
                        AutomationException

Converts a point in device coordinates (typically pixels) to coordinates in page units.

Parameters:

x - The x (in)

y - The y (in)

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanUndoExtent

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

Indicates if there is a page layout extent that can be undone.

Returns:

The bCanUndo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

undoExtent

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

Undo to the previous page layout extent in the stack.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanRedoExtent

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

Indicates if there is a page layout extent that can be redone.

Returns:

The bCanRedo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

redoExtent

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

Redo the next page layout extent in the stack.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInternalObject

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

The internal ArcObjects IPageLayout object.

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

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

A property to associate data with an object.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with an object.

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTitle

void setTitle(java.lang.String currentTitle)
              throws java.io.IOException,
                     AutomationException

The title in the page layout. Not all page layouts have a title that can be changed, use the HasTitle method to check this.

Parameters:

currentTitle - The currentTitle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTitle

java.lang.String getTitle()
                          throws java.io.IOException,
                                 AutomationException

The title in the page layout. Not all page layouts have a title that can be changed, use the HasTitle method to check this.

Returns:

The currentTitle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasTitle

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

Indicates if the page layout has a title that can be changed.

Returns:

The hasTitle

Throws:

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

AutomationException - If the ArcObject component throws an exception.