com.esri.arcgis.controls
Class ArcReaderControl

java.lang.Object
  java.awt.Component
      java.awt.Canvas
          com.esri.arcgis.interop.Ocx
              com.esri.arcgis.controls.ArcReaderControl

All Implemented Interfaces:

IARControl, IARControlDefault, com.esri.arcgis.interop.RemoteObjRef, ImageObserver, MenuContainer, Serializable, Accessible

public class ArcReaderControl
extends com.esri.arcgis.interop.Ocx
implements com.esri.arcgis.interop.RemoteObjRef, IARControl, IARControlDefault

ESRI ArcReaderControl

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Canvas

Canvas.AccessibleAWTCanvas

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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

rootParentContainers, rootWindows

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ArcReaderControl()
Constructs a ArcReaderControl using ArcGIS Engine.

ArcReaderControl(Object o)
Constructs a ArcReaderControl.

Method Summary

void	aboutBox() Displays a dialog of information about the control.
void	addIARControlEventsListener(IARControlEvents theListener) addIARControlEventsListener.
void	addNotify()
boolean	checkDocument(String sFilename) Checks the document filename to determine if its a valid Published Map File (*.PMF), published with permission to load into the control.
void	copyViewToClipboard() Copies the current map or page layout view to the clipboard.
boolean	equals(Object o) Compare this object with another
boolean	esri_isEnabled() Indicates whether the control can respond to user generated events.
void	esri_setEnabled(boolean pbool) Indicates whether the control can respond to user generated events.
void	exportView(int format, String sFilename) Export the current map or page layout view to the file.
int	getAppearance() The appearance of the control.
IARCommandInfo	getARCommandInfo(int tool) The ARCommandInfo contained by the control.
IARConfiguration	getARConfiguration() The ARConfiguration used by the control.
IARPageLayout	getARPageLayout() The page layout contained within the currently loaded document.
IARUnitConverter	getARUnitConverter() The ARUnitConverter contained by the control.
int	getBorderStyle() The border style of the control.
static String	getClsid() getClsid.
int	getCurrentARTool() Current active tool for the control.
Object	getCurrentView() The current map or page layout view.
int	getCurrentViewType() The type of current view.
Object	getCustomProperty() A property to associate data with a control.
String	getDocumentComment() A comment about the currently loaded Published Map File (*.PMF).
String	getDocumentFilename() The file name of the currently loaded Published Map File (*.PMF).
int	getHWnd() Handle to the window associated with the control.
int	getMousePointer() The mouse cursor displayed over the document.
Object	getObject() A property that returns the underlying control.
IARLayer	getSelectedARLayer() The selected ARLayer in the TOC.
IARLayer	getSwipeLayer() The swipe layer used by the control.
int	getTOCWidth() The width of the Table of Contents (TOC) in pixels.
int	getViewHeight() The height of the Active View in pixels.
int	getViewLeft() The number of pixels between the top of the control and the top of the Active View.
int	getViewTop() The number of pixels between the left edge of the control and the left side of the Active View.
int	getViewWidth() The width of the Active View in pixels.
int	getViewWindow() Handle to the view window associated with the control.
boolean	hasDocumentPermission(int docPermission) Indicates if the currently loaded Published Map File (*.PMF) was published with the specified permission.
boolean	isARWindowVisible(int win) Indicates if the specified control window is visible.
boolean	isEnableFileDrop() Indicates whether Published Map Files can be dropped onto the control.
boolean	isHasCustomARConfiguration() Is the current PMF using settings stored in the PMF.
boolean	isShowMapTips() Indicates if map tips are shown when the current view is a map or page layout.
boolean	isShowScrollbars(int viewType) Indicates if the map and page layout scrollbars are visible.
boolean	isTOCVisible() Indicates if the Table of Contents (TOC) is visible.
void	loadDocument(String sFilename, String sPassword) Loads the Published Map File (*.PMF) into the control.
void	printView() Send the current map or page layout view to the printer.
void	refresh(boolean refreshNow) Refresh the control's window.
void	reloadDocument(String sPassword) Reloads the currently loaded Published Map File (*.PMF) back into the control.
void	removeIARControlEventsListener(IARControlEvents theListener) removeIARControlEventsListener.
void	setAppearance(int pappearance) The appearance of the control.
void	setARConfigurationByRef(IARConfiguration ppConfiguration) The ARConfiguration used by the control.
void	setBorderStyle(int pstyle) The border style of the control.
void	setCurrentARTool(int tool) Current active tool for the control.
void	setCurrentViewByRef(Object ppCurrentView) The current map or page layout view.
void	setCustomProperty(Object pVal) A property to associate data with a control.
void	setDocumentFilename(String bsFilename) The file name of the currently loaded Published Map File (*.PMF).
void	setEnableFileDrop(boolean pvbValue) Indicates whether Published Map Files can be dropped onto the control.
void	setMousePointer(int pcursor) The mouse cursor displayed over the document.
void	setShowMapTips(boolean show) Indicates if map tips are shown when the current view is a map or page layout.
void	setShowScrollbars(int viewType, boolean show) Indicates if the map and page layout scrollbars are visible.
void	setSwipeLayerByRef(IARLayer ppLayer) The swipe layer used by the control.
void	setTOCVisible(boolean visible) Indicates if the Table of Contents (TOC) is visible.
void	setTOCWidth(int lWidth) The width of the Table of Contents (TOC) in pixels.
void	showARWindow(int win, boolean show, Object data) Shows or hides the specified control window.
void	suppressResizeDrawing(boolean suppressResize, int resizeHWnd) Suppress full redraw of control during resize operations.
void	unloadDocument() Unloads the currently loaded Published Map File (*.PMF) from the control.

Methods inherited from class com.esri.arcgis.interop.Ocx

checkIfVisible, getMinimumSize, getObjRef, getPreferredSize, paint, removeNotify, setBounds, setBounds, setSize, setSize, zz_doQueuedSets, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet

Methods inherited from class java.awt.Canvas

createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArcReaderControl

public ArcReaderControl()

Constructs a ArcReaderControl using ArcGIS Engine.

ArcReaderControl

public ArcReaderControl(Object o)

Constructs a ArcReaderControl.

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

addIARControlEventsListener

public void addIARControlEventsListener(IARControlEvents theListener)
                                 throws IOException

addIARControlEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.IARControlEvents interface.

Throws:

IOException - If there are communications problems.

removeIARControlEventsListener

public void removeIARControlEventsListener(IARControlEvents theListener)
                                    throws IOException

removeIARControlEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.IARControlEvents interface.

Throws:

IOException - If there are communications problems.

addNotify

public void addNotify()

Overrides:

addNotify in class com.esri.arcgis.interop.Ocx

setBorderStyle

public void setBorderStyle(int pstyle)
                    throws IOException,
                           AutomationException

The border style of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setBorderStyle in interface IARControl

Specified by:

setBorderStyle in interface IARControlDefault

Parameters:

pstyle - A com.esri.arcgis.controls.esriARBorderStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBorderStyle

public int getBorderStyle()
                   throws IOException,
                          AutomationException

The border style of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getBorderStyle in interface IARControl

Specified by:

getBorderStyle in interface IARControlDefault

Returns:

A com.esri.arcgis.controls.esriARBorderStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean pbool)
                     throws IOException,
                            AutomationException

Indicates whether the control can respond to user generated events.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

esri_setEnabled in interface IARControl

Specified by:

esri_setEnabled in interface IARControlDefault

Parameters:

pbool - The pbool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

public boolean esri_isEnabled()
                       throws IOException,
                              AutomationException

Indicates whether the control can respond to user generated events.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

esri_isEnabled in interface IARControl

Specified by:

esri_isEnabled in interface IARControlDefault

Returns:

The pbool

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int pappearance)
                   throws IOException,
                          AutomationException

The appearance of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setAppearance in interface IARControl

Specified by:

setAppearance in interface IARControlDefault

Parameters:

pappearance - A com.esri.arcgis.controls.esriARAppearance constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAppearance

public int getAppearance()
                  throws IOException,
                         AutomationException

The appearance of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getAppearance in interface IARControl

Specified by:

getAppearance in interface IARControlDefault

Returns:

A com.esri.arcgis.controls.esriARAppearance constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

aboutBox

public void aboutBox()
              throws IOException,
                     AutomationException

Displays a dialog of information about the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

aboutBox in interface IARControl

Specified by:

aboutBox in interface IARControlDefault

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadDocument

public void loadDocument(String sFilename,
                         String sPassword)
                  throws IOException,
                         AutomationException

Loads the Published Map File (*.PMF) into the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

loadDocument in interface IARControl

Specified by:

loadDocument in interface IARControlDefault

Parameters:

sFilename - The sFilename (in)

sPassword - The sPassword (in, optional, pass if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unloadDocument

public void unloadDocument()
                    throws IOException,
                           AutomationException

Unloads the currently loaded Published Map File (*.PMF) from the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

unloadDocument in interface IARControl

Specified by:

unloadDocument in interface IARControlDefault

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reloadDocument

public void reloadDocument(String sPassword)
                    throws IOException,
                           AutomationException

Reloads the currently loaded Published Map File (*.PMF) back into the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

reloadDocument in interface IARControl

Specified by:

reloadDocument in interface IARControlDefault

Parameters:

sPassword - The sPassword (in, optional, pass if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentViewByRef

public void setCurrentViewByRef(Object ppCurrentView)
                         throws IOException,
                                AutomationException

The current map or page layout view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setCurrentViewByRef in interface IARControl

Specified by:

setCurrentViewByRef in interface IARControlDefault

Parameters:

ppCurrentView - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentView

public Object getCurrentView()
                      throws IOException,
                             AutomationException

The current map or page layout view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCurrentView in interface IARControl

Specified by:

getCurrentView in interface IARControlDefault

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentComment

public String getDocumentComment()
                          throws IOException,
                                 AutomationException

A comment about the currently loaded Published Map File (*.PMF).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getDocumentComment in interface IARControl

Specified by:

getDocumentComment in interface IARControlDefault

Returns:

The sComment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARPageLayout

public IARPageLayout getARPageLayout()
                              throws IOException,
                                     AutomationException

The page layout contained within the currently loaded document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getARPageLayout in interface IARControl

Specified by:

getARPageLayout in interface IARControlDefault

Returns:

A reference to a com.esri.arcgis.controls.IARPageLayout

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showARWindow

public void showARWindow(int win,
                         boolean show,
                         Object data)
                  throws IOException,
                         AutomationException

Shows or hides the specified control window.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

showARWindow in interface IARControl

Specified by:

showARWindow in interface IARControlDefault

Parameters:

win - A com.esri.arcgis.controls.esriARWindows constant (in)

show - The show (in, optional, pass true if not required)

data - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isARWindowVisible

public boolean isARWindowVisible(int win)
                          throws IOException,
                                 AutomationException

Indicates if the specified control window is visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isARWindowVisible in interface IARControl

Specified by:

isARWindowVisible in interface IARControlDefault

Parameters:

win - A com.esri.arcgis.controls.esriARWindows constant (in)

Returns:

The visible

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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

suppressResizeDrawing in interface IARControl

Specified by:

suppressResizeDrawing in interface IARControlDefault

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.

setTOCWidth

public void setTOCWidth(int lWidth)
                 throws IOException,
                        AutomationException

The width of the Table of Contents (TOC) in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setTOCWidth in interface IARControl

Specified by:

setTOCWidth in interface IARControlDefault

Parameters:

lWidth - The lWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTOCWidth

public int getTOCWidth()
                throws IOException,
                       AutomationException

The width of the Table of Contents (TOC) in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getTOCWidth in interface IARControl

Specified by:

getTOCWidth in interface IARControlDefault

Returns:

The lWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

printView

public void printView()
               throws IOException,
                      AutomationException

Send the current map or page layout view to the printer.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

printView in interface IARControl

Specified by:

printView in interface IARControlDefault

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copyViewToClipboard

public void copyViewToClipboard()
                         throws IOException,
                                AutomationException

Copies the current map or page layout view to the clipboard.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

copyViewToClipboard in interface IARControl

Specified by:

copyViewToClipboard in interface IARControlDefault

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentARTool

public void setCurrentARTool(int tool)
                      throws IOException,
                             AutomationException

Current active tool for the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setCurrentARTool in interface IARControl

Specified by:

setCurrentARTool in interface IARControlDefault

Parameters:

tool - A com.esri.arcgis.controls.esriARTool constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentARTool

public int getCurrentARTool()
                     throws IOException,
                            AutomationException

Current active tool for the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCurrentARTool in interface IARControl

Specified by:

getCurrentARTool in interface IARControlDefault

Returns:

A com.esri.arcgis.controls.esriARTool constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasDocumentPermission

public boolean hasDocumentPermission(int docPermission)
                              throws IOException,
                                     AutomationException

Indicates if the currently loaded Published Map File (*.PMF) was published with the specified permission.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

hasDocumentPermission in interface IARControl

Specified by:

hasDocumentPermission in interface IARControlDefault

Parameters:

docPermission - A com.esri.arcgis.controls.esriARDocumentPermissions constant (in)

Returns:

The hasPermission

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowScrollbars

public void setShowScrollbars(int viewType,
                              boolean show)
                       throws IOException,
                              AutomationException

Indicates if the map and page layout scrollbars are visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setShowScrollbars in interface IARControl

Specified by:

setShowScrollbars in interface IARControlDefault

Parameters:

viewType - A com.esri.arcgis.controls.esriARViewType constant (in)

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowScrollbars

public boolean isShowScrollbars(int viewType)
                         throws IOException,
                                AutomationException

Indicates if the map and page layout scrollbars are visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isShowScrollbars in interface IARControl

Specified by:

isShowScrollbars in interface IARControlDefault

Parameters:

viewType - A com.esri.arcgis.controls.esriARViewType constant (in)

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTOCVisible

public void setTOCVisible(boolean visible)
                   throws IOException,
                          AutomationException

Indicates if the Table of Contents (TOC) is visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setTOCVisible in interface IARControl

Specified by:

setTOCVisible in interface IARControlDefault

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTOCVisible

public boolean isTOCVisible()
                     throws IOException,
                            AutomationException

Indicates if the Table of Contents (TOC) is visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isTOCVisible in interface IARControl

Specified by:

isTOCVisible in interface IARControlDefault

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

Handle to the window associated with the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getHWnd in interface IARControl

Specified by:

getHWnd in interface IARControlDefault

Returns:

The window

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowMapTips

public void setShowMapTips(boolean show)
                    throws IOException,
                           AutomationException

Indicates if map tips are shown when the current view is a map or page layout.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setShowMapTips in interface IARControl

Specified by:

setShowMapTips in interface IARControlDefault

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowMapTips

public boolean isShowMapTips()
                      throws IOException,
                             AutomationException

Indicates if map tips are shown when the current view is a map or page layout.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isShowMapTips in interface IARControl

Specified by:

isShowMapTips in interface IARControlDefault

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh(boolean refreshNow)
             throws IOException,
                    AutomationException

Refresh the control's window.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

refresh in interface IARControl

Specified by:

refresh in interface IARControlDefault

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.

getCurrentViewType

public int getCurrentViewType()
                       throws IOException,
                              AutomationException

The type of current view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCurrentViewType in interface IARControl

Specified by:

getCurrentViewType in interface IARControlDefault

Returns:

A com.esri.arcgis.controls.esriARViewType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARConfiguration

public IARConfiguration getARConfiguration()
                                    throws IOException,
                                           AutomationException

The ARConfiguration used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getARConfiguration in interface IARControl

Specified by:

getARConfiguration in interface IARControlDefault

Returns:

A reference to a com.esri.arcgis.controls.IARConfiguration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setARConfigurationByRef

public void setARConfigurationByRef(IARConfiguration ppConfiguration)
                             throws IOException,
                                    AutomationException

The ARConfiguration used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setARConfigurationByRef in interface IARControl

Specified by:

setARConfigurationByRef in interface IARControlDefault

Parameters:

ppConfiguration - A reference to a com.esri.arcgis.controls.IARConfiguration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARUnitConverter

public IARUnitConverter getARUnitConverter()
                                    throws IOException,
                                           AutomationException

The ARUnitConverter contained by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getARUnitConverter in interface IARControl

Specified by:

getARUnitConverter in interface IARControlDefault

Returns:

A reference to a com.esri.arcgis.controls.IARUnitConverter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public String getDocumentFilename()
                           throws IOException,
                                  AutomationException

The file name of the currently loaded Published Map File (*.PMF).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getDocumentFilename in interface IARControl

Specified by:

getDocumentFilename in interface IARControlDefault

Returns:

The bsFilename

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(String bsFilename)
                         throws IOException,
                                AutomationException

The file name of the currently loaded Published Map File (*.PMF).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setDocumentFilename in interface IARControl

Specified by:

setDocumentFilename in interface IARControlDefault

Parameters:

bsFilename - The bsFilename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkDocument

public boolean checkDocument(String sFilename)
                      throws IOException,
                             AutomationException

Checks the document filename to determine if its a valid Published Map File (*.PMF), published with permission to load into the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

checkDocument in interface IARControl

Specified by:

checkDocument in interface IARControlDefault

Parameters:

sFilename - The sFilename (in)

Returns:

The bIsOK

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARCommandInfo

public IARCommandInfo getARCommandInfo(int tool)
                                throws IOException,
                                       AutomationException

The ARCommandInfo contained by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getARCommandInfo in interface IARControl

Specified by:

getARCommandInfo in interface IARControlDefault

Parameters:

tool - A com.esri.arcgis.controls.esriARTool constant (in)

Returns:

A reference to a com.esri.arcgis.controls.IARCommandInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportView

public void exportView(int format,
                       String sFilename)
                throws IOException,
                       AutomationException

Export the current map or page layout view to the file.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

exportView in interface IARControl

Specified by:

exportView in interface IARControlDefault

Parameters:

format - A com.esri.arcgis.controls.esriARExportFormat constant (in)

sFilename - The sFilename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableFileDrop

public void setEnableFileDrop(boolean pvbValue)
                       throws IOException,
                              AutomationException

Indicates whether Published Map Files can be dropped onto the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setEnableFileDrop in interface IARControl

Specified by:

setEnableFileDrop in interface IARControlDefault

Parameters:

pvbValue - The pvbValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableFileDrop

public boolean isEnableFileDrop()
                         throws IOException,
                                AutomationException

Indicates whether Published Map Files can be dropped onto the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isEnableFileDrop in interface IARControl

Specified by:

isEnableFileDrop in interface IARControlDefault

Returns:

The pvbValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException

A property to associate data with a control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCustomProperty in interface IARControl

Specified by:

getCustomProperty in interface IARControlDefault

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 Desktop. Requires Publisher Extension.

Specified by:

setCustomProperty in interface IARControl

Specified by:

setCustomProperty in interface IARControlDefault

Parameters:

pVal - A Variant (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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getObject in interface IARControl

Specified by:

getObject in interface IARControlDefault

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewTop

public int getViewTop()
               throws IOException,
                      AutomationException

The number of pixels between the left edge of the control and the left side of the Active View.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewTop in interface IARControl

Specified by:

getViewTop in interface IARControlDefault

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewLeft

public int getViewLeft()
                throws IOException,
                       AutomationException

The number of pixels between the top of the control and the top of the Active View.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewLeft in interface IARControl

Specified by:

getViewLeft in interface IARControlDefault

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewHeight

public int getViewHeight()
                  throws IOException,
                         AutomationException

The height of the Active View in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewHeight in interface IARControl

Specified by:

getViewHeight in interface IARControlDefault

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewWidth

public int getViewWidth()
                 throws IOException,
                        AutomationException

The width of the Active View in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewWidth in interface IARControl

Specified by:

getViewWidth in interface IARControlDefault

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasCustomARConfiguration

public boolean isHasCustomARConfiguration()
                                   throws IOException,
                                          AutomationException

Is the current PMF using settings stored in the PMF.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isHasCustomARConfiguration in interface IARControl

Specified by:

isHasCustomARConfiguration in interface IARControlDefault

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSwipeLayerByRef

public void setSwipeLayerByRef(IARLayer ppLayer)
                        throws IOException,
                               AutomationException

The swipe layer used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setSwipeLayerByRef in interface IARControl

Specified by:

setSwipeLayerByRef in interface IARControlDefault

Parameters:

ppLayer - A reference to a com.esri.arcgis.controls.IARLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSwipeLayer

public IARLayer getSwipeLayer()
                       throws IOException,
                              AutomationException

The swipe layer used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getSwipeLayer in interface IARControl

Specified by:

getSwipeLayer in interface IARControlDefault

Returns:

A reference to a com.esri.arcgis.controls.IARLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewWindow

public int getViewWindow()
                  throws IOException,
                         AutomationException

Handle to the view window associated with the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewWindow in interface IARControl

Specified by:

getViewWindow in interface IARControlDefault

Returns:

The window

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int pcursor)
                     throws IOException,
                            AutomationException

The mouse cursor displayed over the document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setMousePointer in interface IARControl

Specified by:

setMousePointer in interface IARControlDefault

Parameters:

pcursor - A com.esri.arcgis.controls.esriARMousePointer constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMousePointer

public int getMousePointer()
                    throws IOException,
                           AutomationException

The mouse cursor displayed over the document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getMousePointer in interface IARControl

Specified by:

getMousePointer in interface IARControlDefault

Returns:

A com.esri.arcgis.controls.esriARMousePointer constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedARLayer

public IARLayer getSelectedARLayer()
                            throws IOException,
                                   AutomationException

The selected ARLayer in the TOC.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getSelectedARLayer in interface IARControl

Specified by:

getSelectedARLayer in interface IARControlDefault

Returns:

A reference to a com.esri.arcgis.controls.IARLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.