com.esri.arcgis.controls
Class IPageLayoutControl3Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.IPageLayoutControlProxy
          extended by com.esri.arcgis.controls.IPageLayoutControl2Proxy
              extended by com.esri.arcgis.controls.IPageLayoutControl3Proxy
All Implemented Interfaces:
IPageLayoutControl, IPageLayoutControl2, IPageLayoutControl3, Externalizable, Serializable

public class IPageLayoutControl3Proxy
extends IPageLayoutControl2Proxy
implements IPageLayoutControl3, 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.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IPageLayoutControl3Proxy()
           
  IPageLayoutControl3Proxy(Object obj)
           
protected IPageLayoutControl3Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 boolean isAutoKeyboardScrolling()
          Indicates whether keyboard scrolling is enabled.
 boolean isAutoMouseWheel()
          Indicates whether the mouse wheel is enabled.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setAutoKeyboardScrolling(boolean enabled)
          Indicates whether keyboard scrolling is enabled.
 void setAutoMouseWheel(boolean enabled)
          Indicates whether the mouse wheel is enabled.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.controls.IPageLayoutControl2Proxy
getCustomProperty, getDocumentFilename, getKeyIntercept, getObject, setCustomProperty, setDocumentFilename, setKeyIntercept, suppressResizeDrawing
 
Methods inherited from class com.esri.arcgis.controls.IPageLayoutControlProxy
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
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
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
 

Constructor Detail

IPageLayoutControl3Proxy

public IPageLayoutControl3Proxy()

IPageLayoutControl3Proxy

public IPageLayoutControl3Proxy(Object obj)
                         throws IOException
Throws:
IOException

IPageLayoutControl3Proxy

protected IPageLayoutControl3Proxy(Object obj,
                                   String iid)
                            throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class IPageLayoutControl2Proxy
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class IPageLayoutControl2Proxy
Throws:
IOException

isAutoMouseWheel

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

Specified by:
isAutoMouseWheel in interface IPageLayoutControl3
Returns:
The enabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoMouseWheel

public void setAutoMouseWheel(boolean enabled)
                       throws IOException,
                              AutomationException
Indicates whether the mouse wheel is enabled.

Product Availability

Available with ArcGIS Engine.

Specified by:
setAutoMouseWheel in interface IPageLayoutControl3
Parameters:
enabled - The enabled (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAutoKeyboardScrolling

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

Specified by:
isAutoKeyboardScrolling in interface IPageLayoutControl3
Returns:
The enabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoKeyboardScrolling

public void setAutoKeyboardScrolling(boolean enabled)
                              throws IOException,
                                     AutomationException
Indicates whether keyboard scrolling is enabled.

Product Availability

Available with ArcGIS Engine.

Specified by:
setAutoKeyboardScrolling in interface IPageLayoutControl3
Parameters:
enabled - The enabled (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class IPageLayoutControl2Proxy
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class IPageLayoutControl2Proxy
Throws:
IOException
ClassNotFoundException