com.esri.arcgis.interop.Dispatch
com.esri.arcgis.controls.IPageLayoutControlDefaultProxy
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class IPageLayoutControlDefaultProxy
Provides access to members that control the PageLayoutControl.
The IPageLayoutControlDefault interface is the default dispatch interface that most development environments will automatically expose. For example, placing the PageLayoutControl in a container will typically generate an object called PageLayoutControl1. The properties and methods available directly on this object correspond to this interface, together with container specific properties and methods.
The IPageLayoutControlDefault interface is a 'pure' dispatch interface, so can be extended with new properties and methods at future releases of ArcGIS. The methods and properties are identical to the highest numbered main interface on the PageLayoutControl. For example, IPageLayoutControlDefault is equivalent to IPageLayoutControl2, but at future releases this could become IPageLayoutControl3. By using the IPageLayoutControlDefault interface you are guaranteed to always have access to the latest PageLayoutControl.
There is a small performance overhead in making calls through to a pure dispatch interface, but to avoid this you can QI to a specific interface. In some development environments it is not possible to QI directly on the control to other COM interfaces, because the control is contained within a wrapper object. Use the Object property to get the real control before performing the QI.
| Field Summary | |
|---|---|
boolean |
noncastable
|
| Fields inherited from class com.esri.arcgis.interop.Dispatch |
|---|
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef |
| Constructor Summary | |
|---|---|
|
IPageLayoutControlDefaultProxy()
|
|
IPageLayoutControlDefaultProxy(Object obj)
|
protected |
IPageLayoutControlDefaultProxy(Object obj,
String iid)
|
| Method Summary | |
|---|---|
void |
aboutBox()
Displays a dialog of information about the PageLayoutControl. |
void |
addElement(IElement pElement,
Object geometry,
Object symbology,
Object name,
int zOrder)
Adds the supplied element to the PageLayout, with optional geometry, symbolization, name and Z order. |
void |
addListener(String iidStr,
Object theListener,
Object theSource)
|
void |
centerAt(IPoint centerPoint)
Moves the center of the PageLayoutControl to the specified location. |
boolean |
checkMxFile(String fileName)
Checks the specified filename to see if it is a map document that can be loaded into the PageLayoutControl. |
boolean |
esri_isEnabled()
Indicates whether the PageLayoutControl can respond to user generated events. |
void |
esri_setEnabled(boolean rhs1)
Indicates whether the PageLayoutControl can respond to user generated events. |
IElement |
findElementByName(String name,
int occurence)
Find the first element with the supplied name, supply an occurrence parameter to find the second, third and so on. |
void |
fromPagePoint(IPoint pt,
int[] x,
int[] y)
Converts a point on the page (in page units) to device co-ordinates (typically pixels). |
IActiveView |
getActiveView()
The active view of the PageLayout contained by the PageLayoutControl. |
int |
getAppearance()
The appearance of the PageLayoutControl. |
int |
getBackColor()
Background color of the PageLayoutControl. |
int |
getBorderStyle()
The border style of the PageLayoutControl. |
ITool |
getCurrentTool()
Current active tool for the PageLayoutControl. |
Object |
getCustomProperty()
A property to associate data with a control. |
String |
getDocumentFilename()
The filename of the last map document loaded into the control. |
IEnvelope |
getExtent()
Current extent of the PageLayout in page units. |
IEnvelope |
getFullExtent()
Rectangular shape that encloses the PageLayout. |
IGraphicsContainer |
getGraphicsContainer()
The graphics container of the PageLayout object contained by the PageLayoutControl. |
int |
getHWnd()
Handle to the window associated with the PageLayoutControl. |
int |
getKeyIntercept()
A property that specifies interception of key strokes that are normally handled by the container. |
Picture |
getMouseIcon()
Custom mouse icon used if MousePointer is 99. |
int |
getMousePointer()
The mouse pointer displayed over the PageLayoutControl. |
Object |
getObject()
A property that returns the underlying control. |
IPage |
getPage()
The Page associated with the PageLayout contained by the PageLayoutControl. |
IPageLayout |
getPageLayout()
The PageLayout contained by the PageLayoutControl. |
IPrinter |
getPrinter()
The printer object used by the PageLayoutControl for printing. |
short |
getPrinterPageCount(double overlap)
The number of printer pages the PageLayout will cover. |
ITrackCancel |
getTrackCancel()
The object used by the PageLayoutControl to check if drawing has been aborted. |
boolean |
isAutoKeyboardScrolling()
Indicates whether keyboard scrolling is enabled. |
boolean |
isAutoMouseWheel()
Indicates whether the mouse wheel is enabled. |
boolean |
isOleDropEnabled()
Indicates if the PageLayoutControl will fire events when data is dragged over the control's window. |
void |
loadMxFile(String fileName,
Object password)
Loads the specified map document into the PageLayout contained by the PageLayoutControl. |
IElement |
locateFrontElement(double pageX,
double pageY,
double tolerance)
Locates an element at the given page co-ordinates. |
void |
pan()
Tracks the mouse while panning the PageLayoutControl. |
void |
printPageLayout(short startPage,
short endPage,
double overlap)
Sends the specified range of pages on the printer. |
void |
refresh(int phase,
Object layerOrElement,
Object envelope)
Redraws the PageLayout, optionally just redraw specified phases or envelope. |
void |
removeListener(String iidStr,
Object theListener)
|
void |
setAppearance(int rhs1)
The appearance of the PageLayoutControl. |
void |
setAutoKeyboardScrolling(boolean rhs1)
Indicates whether keyboard scrolling is enabled. |
void |
setAutoMouseWheel(boolean rhs1)
Indicates whether the mouse wheel is enabled. |
void |
setBackColor(int rhs1)
Background color of the PageLayoutControl. |
void |
setBorderStyle(int rhs1)
The border style of the PageLayoutControl. |
void |
setCurrentToolByRef(ITool rhs1)
Current active tool for the PageLayoutControl. |
void |
setCustomProperty(Object rhs1)
A property to associate data with a control. |
void |
setDocumentFilename(String rhs1)
The filename of the last map document loaded into the control. |
void |
setExtent(IEnvelope rhs1)
Current extent of the PageLayout in page units. |
void |
setFullExtent(IEnvelope rhs1)
Rectangular shape that encloses the PageLayout. |
void |
setKeyIntercept(int rhs1)
A property that specifies interception of key strokes that are normally handled by the container. |
void |
setMouseIconByRef(Picture rhs1)
Custom mouse icon used if MousePointer is 99. |
void |
setMousePointer(int rhs1)
The mouse pointer displayed over the PageLayoutControl. |
void |
setOleDropEnabled(boolean rhs1)
Indicates if the PageLayoutControl will fire events when data is dragged over the control's window. |
void |
setPageLayoutByRef(IPageLayout rhs1)
The PageLayout contained by the PageLayoutControl. |
void |
setPrinterByRef(IPrinter rhs1)
The printer object used by the PageLayoutControl for printing. |
void |
setTrackCancelByRef(ITrackCancel rhs1)
The object used by the PageLayoutControl to check if drawing has been aborted. |
void |
suppressResizeDrawing(boolean suppressResize,
int resizeHWnd)
Suppress full redraw of control during resize operations. |
IPoint |
toPagePoint(int x,
int y)
Converts device co-ordinates (typically pixels) to a point on the page (in page units). |
IEnvelope |
trackRectangle()
Rubber-bands a rectangle on the PageLayoutControl. |
void |
zoomToWholePage()
Changes the extent of the PageLayout to show a whole page. |
| 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 |
| Field Detail |
|---|
public boolean noncastable
| Constructor Detail |
|---|
public IPageLayoutControlDefaultProxy()
public IPageLayoutControlDefaultProxy(Object obj)
throws IOException
IOException
protected IPageLayoutControlDefaultProxy(Object obj,
String iid)
throws IOException
IOException| Method Detail |
|---|
public void addListener(String iidStr,
Object theListener,
Object theSource)
throws IOException
addListener in class com.esri.arcgis.interop.DispatchIOException
public void removeListener(String iidStr,
Object theListener)
throws IOException
removeListener in class com.esri.arcgis.interop.DispatchIOException
public void setBackColor(int rhs1)
throws IOException,
AutomationException
setBackColor in interface IPageLayoutControlDefaultrhs1 - The rhs1 (A COM typedef) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getBackColor()
throws IOException,
AutomationException
Returns or sets the Background Color of the PageLayoutControl. The Background color is used to draw the area of the Control outside the Page itself. Internally the OLE_Color is stored as a long integer where the value may be calculated for any RGB combination as follows:
OLE_Color = (Red) + (Green * 256) + (Blue * 256 * 256)
Where Red, Green and Blue are Long Integers within the range 0 - 255.
getBackColor in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBorderStyle(int rhs1)
throws IOException,
AutomationException
setBorderStyle in interface IPageLayoutControlDefaultrhs1 - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getBorderStyle()
throws IOException,
AutomationException
Returns or sets the border style of a PageLayoutControl. By default a border is drawn.
getBorderStyle in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void esri_setEnabled(boolean rhs1)
throws IOException,
AutomationException
esri_setEnabled in interface IPageLayoutControlDefaultrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean esri_isEnabled()
throws IOException,
AutomationException
esri_isEnabled in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAppearance(int rhs1)
throws IOException,
AutomationException
setAppearance in interface IPageLayoutControlDefaultrhs1 - A com.esri.arcgis.controls.esriControlsAppearance constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getAppearance()
throws IOException,
AutomationException
Returns or sets the paint style of a PageLayoutControl to either Flat or 3D. By default the appearance is flat.
getAppearance in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMousePointer(int rhs1)
throws IOException,
AutomationException
setMousePointer in interface IPageLayoutControlDefaultrhs1 - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getMousePointer()
throws IOException,
AutomationException
Use this property when you want to indicate changes in functionality as the mouse pointer passes over the PageLayoutControl. The esriPointerArrowHourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish.
getMousePointer in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMouseIconByRef(Picture rhs1)
throws IOException,
AutomationException
The MouseIcon property provides a custom icon that is used when the IPageLayoutControlDefault::MousePointer property is set to 99.
You can use the MouseIcon property to load either cursor (.cur) or icon (.ico) files. The MouseIcon property provides your program with easy access to custom cursors of any size, with any desired hot spot location. This property cannot be used to load animated cursor (.ani) files.
PageLayoutControl1.MouseIcon = LoadPicture("c:\winnt\cursors\mycursor.cur")
setMouseIconByRef in interface IPageLayoutControlDefaultrhs1 - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Picture getMouseIcon()
throws IOException,
AutomationException
The MouseIcon property provides a custom icon that is used when the MousePointer property is set to esriPointerArrowHourglass (99).
In most development evironments the control's property pages can be used to load either a cursor (.cur) or icon (.ico) file. A cursor contains a custom 'hotspot' location and can be any size. The 'hotspot' location for an icon file defaults to the center of the icon. This property cannot be used to load animated cursor (.ani) files.
To programatically create an object implementing IPictureDisp there is the win32 function OleLoadPicture or helper methods depending on the development environment.
getMouseIcon in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getHWnd()
throws IOException,
AutomationException
The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd. Many ArcObjects methods and Windows API calls require the hWnd as an argument.
getHWnd in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void aboutBox()
throws IOException,
AutomationException
The AboutBox method causes a modal dialog box to display on top of the PageLayoutControl, containing information about the version and creation date of the PageLayoutControl as well as listing relevant legal and copyright information from ESRI.
aboutBox in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITool getCurrentTool()
throws IOException,
AutomationException
The CurrentTool is the tool used to interact will the PageLayoutControl's display. Always check if a tool is enabled before setting it to the CurrentTool property, otherwise a user will be able to use a tool that is actually disabled.
When the CurrentTool is set the following events occur:
Within an ITool implementation it is recommended that the ITool::Deactivate event returns true. This allows a 'new' CurrentTool to be set, and allows the release of the CurrentTool when an application is shutting down.
getCurrentTool in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCurrentToolByRef(ITool rhs1)
throws IOException,
AutomationException
setCurrentToolByRef in interface IPageLayoutControlDefaultrhs1 - A reference to a com.esri.arcgis.systemUI.ITool (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPageLayout getPageLayout()
throws IOException,
AutomationException
This is the PageLayout CoClass contained within the PageLayoutControl. If the PageLayout is replaced the IPageLayoutControlEvents::OnPageLayoutReplaced event is triggered.
getPageLayout in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPageLayoutByRef(IPageLayout rhs1)
throws IOException,
AutomationException
setPageLayoutByRef in interface IPageLayoutControlDefaultrhs1 - A reference to a com.esri.arcgis.carto.IPageLayout (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IActiveView getActiveView()
throws IOException,
AutomationException
This is the ActiveView on the PageLayout CoClass contained within the PageLayoutControl.
When the PageLayoutControl is added to a container the PageLayout's element selection, IActiveView::Selection, is Nothing. This causes the esriViewGraphicSelection draw phase to ignore any selected graphics. To resolve this, set the IActiveView::Selection property to the IViewManager::ElementSelection property. This will result in the MapFrame element becoming selected.
The IActiveView::ShowRuler property will not display any rulers on the PageLayout because the PageLayoutControl does not itself manage rulers. An application must draw its own rulers.
getActiveView in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getExtent()
throws IOException,
AutomationException
Returns or sets a new envelope which is represents the visible extent of the PageLayout. Setting the Extent property will automatically cause the PageLayoutControl to refresh its display.
getExtent in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExtent(IEnvelope rhs1)
throws IOException,
AutomationException
setExtent in interface IPageLayoutControlDefaultrhs1 - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getFullExtent()
throws IOException,
AutomationException
Returns or sets an envelope object which by default is the PageLayout's page size expanded by a factor of 1.9 and which is automatically set whenever the page size changes. Setting the FullExtent triggers the IPageLayoutControlEvents::OnFullExtentUpated event.
The FullExtent property is a shortcut to IActiveView::FullExtent which is in turn a shortcut to IDisplayTransformation::Bounds. Setting the FullExtent property will not affect the Extent property.
getFullExtent in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFullExtent(IEnvelope rhs1)
throws IOException,
AutomationException
setFullExtent in interface IPageLayoutControlDefaultrhs1 - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPage getPage()
throws IOException,
AutomationException
The Page property is based upon the IPageLayout::Page property. Use the Page to manage the on screen visual representation of the printer page such as page size and orientation.
getPage in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGraphicsContainer getGraphicsContainer()
throws IOException,
AutomationException
This property is a shortcut to IActiveView::GraphicsContainer.
This property will always return a reference to the PageLayout's GraphicsContainer rather than to any GraphicsContainer associated with a Map.
getGraphicsContainer in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void printPageLayout(short startPage,
short endPage,
double overlap)
throws IOException,
AutomationException
PrintPageLayout sends the PageLayout to the Printer. If the Page does not fit the IPrinter::Paper, the value of IPage::PageToPrinterMapping will determine whether the Page is cropped, scaled or tiled across the Printer's paper.
Before using the PrintPageLayout property, ensure that the orientation of IPrinter::Paper is the same orientation as the Page.
printPageLayout in interface IPageLayoutControlDefaultstartPage - The startPage (in, optional, pass 1 if not required)endPage - The endPage (in, optional, pass 0 if not required)overlap - The overlap (in, optional, pass 0 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPrinter getPrinter()
throws IOException,
AutomationException
Unless the Printer property has been set to a specific printer, the property will return the default system printer. Before issuing a print always check that the PageLayoutControl has a printer.
getPrinter in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPrinterByRef(IPrinter rhs1)
throws IOException,
AutomationException
setPrinterByRef in interface IPageLayoutControlDefaultrhs1 - A reference to a com.esri.arcgis.output.IPrinter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITrackCancel getTrackCancel()
throws IOException,
AutomationException
Use the TrackCancel object to enable users to stop printing, exporting or drawing processes by using the escape or spacebar keys.
getTrackCancel in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTrackCancelByRef(ITrackCancel rhs1)
throws IOException,
AutomationException
setTrackCancelByRef in interface IPageLayoutControlDefaultrhs1 - A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void pan()
throws IOException,
AutomationException
Pan preserves the scale of the PageLayout, but changes the Extent property.
Use the Pan method within the IPageLayoutControlEvents::OnMouseDown event to allow the user to pan contents of the PageLayoutControl. The IPageLayoutControlEvents::OnMouseMove event will be triggered during the pan, but no IPageLayoutControlEvents::OnMouseUp event will occur. The ESC key on the keyboard can be used during panning to cancel the Pan.
pan in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void centerAt(IPoint centerPoint)
throws IOException,
AutomationException
The CenterAt method positions the supplied point in the center of the PageLayoutControl. The Extent of the PageLayoutControl will change, but the scale will remain the same.
centerAt in interface IPageLayoutControlDefaultcenterPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope trackRectangle()
throws IOException,
AutomationException
Use the TrackRectangle method within the IPageLayoutControlEvents::OnMouseDown event to rubberband a user defined rectangle. The IPageLayoutControlEvents::OnMouseMove event will be triggered during the track, but no IPageLayoutControlEvents::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackRectangle.
trackRectangle in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addElement(IElement pElement,
Object geometry,
Object symbology,
Object name,
int zOrder)
throws IOException,
AutomationException
Adds an element to the GraphicsContainer.
geometry an object that implements IGeometry
symbology an object that implements ISymbol or
IColor
(symbology is applied to the element using the IPropertySupport
interface)
name a string
addElement in interface IPageLayoutControlDefaultpElement - A reference to a com.esri.arcgis.carto.IElement (in)geometry - A Variant (in, optional, pass null if not required)symbology - A Variant (in, optional, pass null if not required)name - A Variant (in, optional, pass null if not required)zOrder - The zOrder (in, optional, pass 0 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IElement locateFrontElement(double pageX,
double pageY,
double tolerance)
throws IOException,
AutomationException
LocateFrontElement is typically used within the IPageLayoutControlEvents::OnMouseDown event to retrieve an element at the given page coordinates. If more than one element exists at the given page coordinates, the element located at the front is returned.
locateFrontElement in interface IPageLayoutControlDefaultpageX - The pageX (in)pageY - The pageY (in)tolerance - The tolerance (in, optional, pass 0 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IElement findElementByName(String name,
int occurence)
throws IOException,
AutomationException
If an empty string is supplied then any elements with no name are found. By default new elements are created with no name. To give an element a name so it can easily be found use one of the following methods: either supply a name string when using the AddElement method, or implement the IElementProperties interface.
findElementByName in interface IPageLayoutControlDefaultname - The name (in)occurence - The occurence (in, optional, pass 1 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void loadMxFile(String fileName,
Object password)
throws IOException,
AutomationException
Loads an map document into the PageLayoutControl. The map document can be an ArcMap document, an ArcMap template or an ArcReader document. Use the CheckMxFile method to determine if the specified map document is a valid map document.
When LoadMXfile is used the user may be prompted for a password; refer to the tables below to determine when this may occur. Additionally, password prompts may be given if accessing MapDocuments using either the PageLayoutControl's PropertyPage, ArcMap or ArcReader; the tables also show in what circumstances this will occur.
Loading Map Documents (*.mxd, *.mxt, *.pmf) which reference IMS Services (with and without security)
| Application | No Secure Services MXD/ MXT/ PMF files | Secure Servcies MXD/ MXT/ PMF files | Secure Servcies (password cached) MXD/ MXT files | Secure Servcies (password cached) PMF files |
|---|---|---|---|---|
| PageLayoutControl (programmatically) | No Prompt | Prompt | No Prompt | Prompt |
| PageLayoutControl (property pages) | No Prompt | Prompt | No Prompt | Prompt |
| ArcMap | No Prompt | Prompt | No Prompt | Prompt |
| ArcReader (PMF files only) | No Prompt | Prompt | N/A | No Prompt |
* The Connection to the Internet server must have the Save User/ Password setting enabled. This can be set, for example, when using Add Internet Server in the Add Layers Dialog. Additionally, in the case of PMF files the ArcPublisher Cache password in PMF file setting must be enabled.
Loading Published Map Files (*.pmf) (with and without password protection)
| Application | PMF with No Password | PMF with Password |
|---|---|---|
| PageLayoutControl (programmatically) | No Prompt | Supply in Code |
| PageLayoutControl (property pages) | No Prompt | Prompt |
| ArcMap | No Prompt | Prompt |
| ArcReader | No Prompt | Prompt |
loadMxFile in interface IPageLayoutControlDefaultfileName - The fileName (in)password - A Variant (in, optional, pass null if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isOleDropEnabled()
throws IOException,
AutomationException
Indicates if the PageLayoutControl will accept data dragged from another application and fire the IPageLayoutControlEvents::OnOleDrop event. By default the OleDropEnabled property is set to false.
isOleDropEnabled in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOleDropEnabled(boolean rhs1)
throws IOException,
AutomationException
setOleDropEnabled in interface IPageLayoutControlDefaultrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean checkMxFile(String fileName)
throws IOException,
AutomationException
Determines whether the specified map document (*.mxd, *.mxt, *.pmf) is a valid map document and can be loaded into the PageLayoutControl. The method verifies the file exists and verifies the file internals conform to an expected storage format. The method does not read and validate the entire contents of the file; use the LoadMxFile to do this.
checkMxFile in interface IPageLayoutControlDefaultfileName - The fileName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void zoomToWholePage()
throws IOException,
AutomationException
The method is based upon the IPageLayout::ZoomToWhole method.
zoomToWholePage in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public short getPrinterPageCount(double overlap)
throws IOException,
AutomationException
getPrinterPageCount in interface IPageLayoutControlDefaultoverlap - The overlap (in, optional, pass 0 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void refresh(int phase,
Object layerOrElement,
Object envelope)
throws IOException,
AutomationException
Use the Refresh method to redraw the display. If the Refresh method is used and no arguments are supplied the refresh is based upon the IActiveView::Refresh method.
In all other cases the refresh is based upon the IActiveView::PartialRefresh method. The Refresh method supports the esriViewDrawPhases given below:
0 :esriViewNone
1 :esriViewBackground
2 :esriViewGeography
4 :esriViewGeoSelection
8 :esriViewGraphics
16 :esriViewSelection
32 :esriViewForeground
If the Refresh method is used and no phase argument is supplied, but one of the other arguments is supplied then all phases will be refreshed and the phase value will be 65535. Always supply a phase whenever possible to increase efficiency.
Use the layerOrElement argument to refresh a particular layer or graphic element. Use the envelope argument to refresh only a particular region. For example, if a new graphic is added you may only want to refresh the area surrounding the graphic.
Use the TrackCancel object to set whether users can stop drawing processes by using the escape or spacebar keys or by clicking the mouse.
refresh in interface IPageLayoutControlDefaultphase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in, optional, pass 65535 if not required)layerOrElement - A Variant (in, optional, pass null if not required)envelope - A Variant (in, optional, pass null if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void fromPagePoint(IPoint pt,
int[] x,
int[] y)
throws IOException,
AutomationException
The FromPagePoint method takes an input point in IPage::Units, and populates two variables with the equivalent control coordinates in pixels.
fromPagePoint in interface IPageLayoutControlDefaultpt - A reference to a com.esri.arcgis.geometry.IPoint (in)x - The x (in/out: use single element array)y - The y (in/out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPoint toPagePoint(int x,
int y)
throws IOException,
AutomationException
ToPagePoint converts a (X,Y) location in pixels to IPage::Units.
toPagePoint in interface IPageLayoutControlDefaultx - The x (in)y - The y (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getCustomProperty()
throws IOException,
AutomationException
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.
getCustomProperty in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCustomProperty(Object rhs1)
throws IOException,
AutomationException
setCustomProperty in interface IPageLayoutControlDefaultrhs1 - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void suppressResizeDrawing(boolean suppressResize,
int resizeHWnd)
throws IOException,
AutomationException
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.
suppressResizeDrawing in interface IPageLayoutControlDefaultsuppressResize - The suppressResize (in)resizeHWnd - The resizeHWnd (in, optional, pass 0 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getDocumentFilename()
throws IOException,
AutomationException
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.
getDocumentFilename in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDocumentFilename(String rhs1)
throws IOException,
AutomationException
setDocumentFilename in interface IPageLayoutControlDefaultrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getObject()
throws IOException,
AutomationException
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.
getObject in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getKeyIntercept()
throws IOException,
AutomationException
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).
getKeyIntercept in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setKeyIntercept(int rhs1)
throws IOException,
AutomationException
setKeyIntercept in interface IPageLayoutControlDefaultrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isAutoMouseWheel()
throws IOException,
AutomationException
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.
isAutoMouseWheel in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAutoMouseWheel(boolean rhs1)
throws IOException,
AutomationException
Determines whether the keyboard the control's display. This property is true by default.
setAutoMouseWheel in interface IPageLayoutControlDefaultrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isAutoKeyboardScrolling()
throws IOException,
AutomationException
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.
isAutoKeyboardScrolling in interface IPageLayoutControlDefaultIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAutoKeyboardScrolling(boolean rhs1)
throws IOException,
AutomationException
setAutoKeyboardScrolling in interface IPageLayoutControlDefaultrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||