com.esri.arcgis.controls
Interface IARPageLayout

All Superinterfaces:
Serializable
All Known Implementing Classes:
ARPageLayout, IARPageLayoutProxy

public interface IARPageLayout
extends Serializable

Provides access to members that control the ARPageLayout.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.


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.
 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.
 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.
 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(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(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.
 

Method Detail

setExtent

void setExtent(double xMin,
               double yMin,
               double xMax,
               double yMax)
               throws IOException,
                      AutomationException
Sets the visible extent of the page layout.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
xMin - The xMin (in)
yMin - The yMin (in)
xMax - The xMax (in)
yMax - The yMax (in)
Throws:
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 IOException,
                      AutomationException
The visible extent of the page layout.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFocusARMapByRef

void setFocusARMapByRef(IARMap ppARMap)
                        throws IOException,
                               AutomationException
The current focus map that the current tool acts upon.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
ppARMap - A reference to a com.esri.arcgis.controls.IARMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFocusARMap

IARMap getFocusARMap()
                     throws IOException,
                            AutomationException
The current focus map that the current tool acts upon.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getARMapCount

int getARMapCount()
                  throws IOException,
                         AutomationException
The number of maps in the page layout's map collection.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getARMap

IARMap getARMap(int index)
                throws IOException,
                       AutomationException
The map at the specified index.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.controls.IARMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPageUnits

void setPageUnits(int units)
                  throws IOException,
                         AutomationException
The units of the page and all associated coordinates.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
units - A com.esri.arcgis.controls.esriARUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageUnits

int getPageUnits()
                 throws IOException,
                        AutomationException
The units of the page and all associated coordinates.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A com.esri.arcgis.controls.esriARUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZoomPercent

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomToPercent

void zoomToPercent(int percent)
                   throws IOException,
                          AutomationException
Magnifies the page by a percentage (100 means actual size, 200 means twice the normal size).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomToWholePage

void zoomToWholePage()
                     throws IOException,
                            AutomationException
Zooms to the whole page.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomToWidth

void zoomToWidth()
                 throws IOException,
                        AutomationException
Fits the width of the page into the page layout display area.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

refresh

void refresh(boolean refreshNow)
             throws IOException,
                    AutomationException
Redraws the page layout display area.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
refreshNow - The refreshNow (in, optional, pass false if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapExtentType

int getMapExtentType(IARMap pMap)
                     throws IOException,
                            AutomationException
The extent type of the specified map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
pMap - A reference to a com.esri.arcgis.controls.IARMap (in)
Returns:
A com.esri.arcgis.controls.esriARExtentType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hitTestMap

IARMap hitTestMap(int x,
                  int y)
                  throws 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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
x - The x (in)
y - The y (in)
Returns:
A reference to a com.esri.arcgis.controls.IARMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomIn

void zoomIn(double factor)
            throws IOException,
                   AutomationException
Zooms in on the page layout by a factor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomOut

void zoomOut(double factor)
             throws IOException,
                    AutomationException
Zooms out on the page layout by a factor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

pan

void pan(int direction,
         double screenPercentage)
         throws IOException,
                AutomationException
Pans the page layout by a factor in a specified direction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
direction - A com.esri.arcgis.controls.esriARDirection constant (in)
screenPercentage - The screenPercentage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAt

void centerAt(double xCoord,
              double yCoord)
              throws IOException,
                     AutomationException
Moves the center of the page layout to the specified point.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getWidth

double getWidth()
                throws IOException,
                       AutomationException
The width of the page.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getHeight

double getHeight()
                 throws IOException,
                        AutomationException
The height of the page.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The dHeight
Throws:
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 IOException,
                        AutomationException
Converts a point in device coordinates (typically pixels) to coordinates in page units.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUndoExtent

boolean isCanUndoExtent()
                        throws IOException,
                               AutomationException
Indicates if there is a page layout extent that can be undone.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

undoExtent

void undoExtent()
                throws IOException,
                       AutomationException
Undo to the previous page layout extent in the stack.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

isCanRedoExtent

boolean isCanRedoExtent()
                        throws IOException,
                               AutomationException
Indicates if there is a page layout extent that can be redone.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

redoExtent

void redoExtent()
                throws IOException,
                       AutomationException
Redo the next page layout extent in the stack.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getInternalObject

Object getInternalObject()
                         throws IOException,
                                AutomationException
The internal ArcObjects IPageLayout object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

Object getCustomProperty()
                         throws IOException,
                                AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTitle

void setTitle(String currentTitle)
              throws 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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getTitle

String getTitle()
                throws 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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

isHasTitle

boolean isHasTitle()
                   throws IOException,
                          AutomationException
Indicates if the page layout has a title that can be changed.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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