com.esri.arcgis.controls
Interface IPageLayoutControl3

All Superinterfaces:

IPageLayoutControl, IPageLayoutControl2, Serializable

All Known Implementing Classes:

IPageLayoutControl3Proxy, PageLayoutControl

public interface IPageLayoutControl3
extends IPageLayoutControl2, Serializable

Provides access to members that control the PageLayoutControl.

Description

The IPageLayoutControl3 interface provides additional members for tasks related to navigating the display of the PageLayoutControl using the keyboard and mouse.

Product Availability

Available with ArcGIS Engine.

Method Summary

boolean	isAutoKeyboardScrolling() Indicates whether keyboard scrolling is enabled.
boolean	isAutoMouseWheel() Indicates whether the mouse wheel is enabled.
void	setAutoKeyboardScrolling(boolean enabled) Indicates whether keyboard scrolling is enabled.
void	setAutoMouseWheel(boolean enabled) Indicates whether the mouse wheel is enabled.

Methods inherited from interface com.esri.arcgis.controls.IPageLayoutControl2

getCustomProperty, getDocumentFilename, getKeyIntercept, getObject, setCustomProperty, setDocumentFilename, setKeyIntercept, suppressResizeDrawing

Methods inherited from interface com.esri.arcgis.controls.IPageLayoutControl

aboutBox, addElement, centerAt, checkMxFile, esri_isEnabled, esri_setEnabled, findElementByName, fromPagePoint, getActiveView, getAppearance, getBackColor, getBorderStyle, getCurrentTool, getExtent, getFullExtent, getGraphicsContainer, getHWnd, getMouseIcon, getMousePointer, getPage, getPageLayout, getPrinter, getPrinterPageCount, getTrackCancel, isOleDropEnabled, loadMxFile, locateFrontElement, pan, printPageLayout, refresh, setAppearance, setBackColor, setBorderStyle, setCurrentToolByRef, setExtent, setFullExtent, setMouseIconByRef, setMousePointer, setOleDropEnabled, setPageLayoutByRef, setPrinterByRef, setTrackCancelByRef, toPagePoint, trackRectangle, zoomToWholePage

Method Detail

isAutoMouseWheel

boolean isAutoMouseWheel()
                         throws IOException,
                                AutomationException

Indicates whether the mouse wheel is enabled.

Description

Determines whether the mouse wheel can be used to zoom in and zoom out of the control's display. This property is true by default.

Product Availability

Available with ArcGIS Engine.

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoMouseWheel

void setAutoMouseWheel(boolean enabled)
                       throws IOException,
                              AutomationException

Indicates whether the mouse wheel is enabled.

Product Availability

Available with ArcGIS Engine.

Parameters:

enabled - The enabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoKeyboardScrolling

boolean isAutoKeyboardScrolling()
                                throws IOException,
                                       AutomationException

Indicates whether keyboard scrolling is enabled.

Description

Determines whether the 'Home' (keyCode 36), 'End' (keyCode 35), 'Page Down' (keyCode 34), 'PageUp' (keyCode 33) and 'Arrow' (keyCode 37-40) keys on the keyboard can be used to pan around the control's display. This property is true by default.

Most development environments use the 'Arrow' keys to switch focus between the controls embedded in a form or container. In such environments the PageLayoutControl will not by default receive the 'Arrow' keys to pan the display. To ensure 'Arrow' keys are received by the PageLayoutControl the KeyIntercept property must be set to intercept the 'Arrow' keys in order to pan the display when AutoKeyboardScrolling is true.

Product Availability

Available with ArcGIS Engine.

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoKeyboardScrolling

void setAutoKeyboardScrolling(boolean enabled)
                              throws IOException,
                                     AutomationException

Indicates whether keyboard scrolling is enabled.

Product Availability

Available with ArcGIS Engine.

Parameters:

enabled - The enabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.