com.esri.arcgis.controls
Class IPageLayoutControl2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IPageLayoutControlProxy
          com.esri.arcgis.controls.IPageLayoutControl2Proxy

All Implemented Interfaces:

IPageLayoutControl, IPageLayoutControl2, Externalizable, Serializable

Direct Known Subclasses:

IPageLayoutControl3Proxy

public class IPageLayoutControl2Proxy
extends IPageLayoutControlProxy
implements IPageLayoutControl2, Serializable

Provides access to members that control the PageLayoutControl.

Superseded By

IPageLayoutControl3

Description

The IPageLayoutControl2 interface provides additional members for tasks related to the PageLayoutControl, such as setting a custom property and suppressing data redraw whilst the PageLayoutControl is being resized.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IPageLayoutControl2Proxy()
	IPageLayoutControl2Proxy(Object obj)
protected	IPageLayoutControl2Proxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
Object	getCustomProperty() A property to associate data with a control.
String	getDocumentFilename() The filename of the last map document loaded into the control.
int	getKeyIntercept() A property that specifies interception of key strokes that are normally handled by the container.
Object	getObject() A property that returns the underlying control.
void	removeListener(String iidStr, Object theListener)
void	setCustomProperty(Object pVal) A property to associate data with a control.
void	setDocumentFilename(String pVal) The filename of the last map document loaded into the control.
void	setKeyIntercept(int pVal) A property that specifies interception of key strokes that are normally handled by the container.
void	suppressResizeDrawing(boolean suppressResize, int resizeHWnd) Suppress full redraw of control during resize operations.

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IPageLayoutControl2Proxy

public IPageLayoutControl2Proxy()

IPageLayoutControl2Proxy

public IPageLayoutControl2Proxy(Object obj)
                         throws IOException

Throws:

IOException

IPageLayoutControl2Proxy

protected IPageLayoutControl2Proxy(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 IPageLayoutControlProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class IPageLayoutControlProxy

Throws:

IOException

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException

A property to associate data with a control.

Description

Use the CustomProperty to associate any useful data with the PageLayoutControl. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.

Product Availability

Available with ArcGIS Engine.

Specified by:

getCustomProperty in interface IPageLayoutControl2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException

A property to associate data with a control.

Product Availability

Available with ArcGIS Engine.

Specified by:

setCustomProperty in interface IPageLayoutControl2

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

suppressResizeDrawing

public void suppressResizeDrawing(boolean suppressResize,
                                  int resizeHWnd)
                           throws IOException,
                                  AutomationException

Suppress full redraw of control during resize operations.

Description

If the PageLayoutControl contains a lot of data, redrawing this data during a resize event can be costly. To increase performance you can suppress the data redraw until the resizing is complete with the SuppressResizeDrawing method. During the resize a stretched bitmap will be drawn instead.

Passing the suppressResize value sets the IScreenDisplay::SuppressResize property on the ActiveView. Pass True to suppress normal drawing and draw a stretched bitmap when a resize event begins. During the resize the data is not refereshed and the captured image is stretched. As such, the image can appear pixelated when a small display area is resized to a large display area. Pass False to resume normal drawing when a resize event ends.

In development environments that do not trap the beginning and end of a resize event, the PageLayoutControl can 'watch' the hwnd supplied to the SuppressResizeDrawing method. When a form or container starts resizing the WM_ENTERSIZEMOVE windows messge is sent and the PageLayoutControl will set suppressResize to True. When windows sends the WM_EXITSIZEMOVE message the form or container is released from resizing and the the PageLayoutControl will set suppressResize to False. Pass the hwnd of the form or container to the SuppressResizeDrawing method when the form or container is initialized. Passing an hwnd of 0 will stop the PageLayoutControl watching the hwnd.

Product Availability

Available with ArcGIS Engine.

Specified by:

suppressResizeDrawing in interface IPageLayoutControl2

Parameters:

suppressResize - The suppressResize (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public String getDocumentFilename()
                           throws IOException,
                                  AutomationException

The filename of the last map document loaded into the control.

Description

Returns the DocumentFilename of the last document loaded into the PagelayoutControl with the LoadMxFile method. An empty string will be returned if no document is loaded.

Product Availability

Available with ArcGIS Engine.

Specified by:

getDocumentFilename in interface IPageLayoutControl2

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(String pVal)
                         throws IOException,
                                AutomationException

The filename of the last map document loaded into the control.

Product Availability

Available with ArcGIS Engine.

Specified by:

setDocumentFilename in interface IPageLayoutControl2

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

public Object getObject()
                 throws IOException,
                        AutomationException

A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Description

In some development environments it is not possible to query interface directly on the control to other COM interfaces, beacuse the control is contained within a wrapper object. To get the real control use the Object property.

Product Availability

Available with ArcGIS Engine.

Specified by:

getObject in interface IPageLayoutControl2

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws IOException,
                           AutomationException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Description

Returns or sets keys on the keyboard that will be intercepted by the PageLayoutControl, triggering the OnKeyDown and OnKeyUp events when pressed. These keys are often hidden from the PageLayoutControl by the development environment container. By default the KeyIntercept is set to esriKeyInterceptNone .

Many development environment containers use the up, down, left and right arrow keys to change control focus on a form. These keys can also be useful for navigating around the display. To intercept the arrow keys and the Tab key combine the enum values using a logical OR operation (esriKeyInterceptArrowKeys OR esriKeyInterceptTabKey, which is 1 OR 4 = 5).

Product Availability

Available with ArcGIS Engine.

Specified by:

getKeyIntercept in interface IPageLayoutControl2

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int pVal)
                     throws IOException,
                            AutomationException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Product Availability

Available with ArcGIS Engine.

Specified by:

setKeyIntercept in interface IPageLayoutControl2

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.