com.esri.arcgis.controls
Interface IARControl

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcReaderControl, IARControlProxy

public interface IARControl
extends Serializable

Provides access to members on the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.


Method Summary
 void aboutBox()
          Displays a dialog of information about the control.
 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 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.
 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 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.
 

Method Detail

setBorderStyle

void setBorderStyle(int pstyle)
                    throws IOException,
                           AutomationException
The border style of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

int getBorderStyle()
                   throws IOException,
                          AutomationException
The border style of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

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.

Parameters:
pbool - The pbool (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

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.

Returns:
The pbool
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAppearance

void setAppearance(int pappearance)
                   throws IOException,
                          AutomationException
The appearance of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

int getAppearance()
                  throws IOException,
                         AutomationException
The appearance of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A com.esri.arcgis.controls.esriARAppearance constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

aboutBox

void aboutBox()
              throws IOException,
                     AutomationException
Displays a dialog of information about the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadDocument

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.

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

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.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reloadDocument

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.

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

void setCurrentViewByRef(Object ppCurrentView)
                         throws IOException,
                                AutomationException
The current map or page layout view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

Object getCurrentView()
                      throws IOException,
                             AutomationException
The current map or page layout view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentComment

String getDocumentComment()
                          throws IOException,
                                 AutomationException
A comment about the currently loaded Published Map File (*.PMF).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The sComment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARPageLayout

IARPageLayout getARPageLayout()
                              throws IOException,
                                     AutomationException
The page layout contained within the currently loaded document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

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.

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

boolean isARWindowVisible(int win)
                          throws IOException,
                                 AutomationException
Indicates if the specified control window is visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

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.

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

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.

Parameters:
lWidth - The lWidth (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTOCWidth

int getTOCWidth()
                throws IOException,
                       AutomationException
The width of the Table of Contents (TOC) in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The lWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

printView

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.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copyViewToClipboard

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.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentARTool

void setCurrentARTool(int tool)
                      throws IOException,
                             AutomationException
Current active tool for the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

int getCurrentARTool()
                     throws IOException,
                            AutomationException
Current active tool for the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A com.esri.arcgis.controls.esriARTool constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasDocumentPermission

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.

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

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.

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

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.

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

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.

Parameters:
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTOCVisible

boolean isTOCVisible()
                     throws IOException,
                            AutomationException
Indicates if the Table of Contents (TOC) is visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException
Handle to the window associated with the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The window
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowMapTips

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.

Parameters:
show - The show (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowMapTips

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.

Returns:
The show
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(boolean refreshNow)
             throws IOException,
                    AutomationException
Refresh the control's window.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

int getCurrentViewType()
                       throws IOException,
                              AutomationException
The type of current view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A com.esri.arcgis.controls.esriARViewType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARConfiguration

IARConfiguration getARConfiguration()
                                    throws IOException,
                                           AutomationException
The ARConfiguration used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

void setARConfigurationByRef(IARConfiguration ppConfiguration)
                             throws IOException,
                                    AutomationException
The ARConfiguration used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

IARUnitConverter getARUnitConverter()
                                    throws IOException,
                                           AutomationException
The ARUnitConverter contained by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

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.

Returns:
The bsFilename
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

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.

Parameters:
bsFilename - The bsFilename (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkDocument

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.

Parameters:
sFilename - The sFilename (in)
Returns:
The bIsOK
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARCommandInfo

IARCommandInfo getARCommandInfo(int tool)
                                throws IOException,
                                       AutomationException
The ARCommandInfo contained by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

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.

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

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.

Parameters:
pvbValue - The pvbValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnableFileDrop

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.

Returns:
The pvbValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

Object getCustomProperty()
                         throws IOException,
                                AutomationException
A property to associate data with a control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException
A property to associate data with a control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObject

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.

Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewTop

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.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewLeft

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.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewHeight

int getViewHeight()
                  throws IOException,
                         AutomationException
The height of the Active View in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewWidth

int getViewWidth()
                 throws IOException,
                        AutomationException
The width of the Active View in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasCustomARConfiguration

boolean isHasCustomARConfiguration()
                                   throws IOException,
                                          AutomationException
Is the current PMF using settings stored in the PMF.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSwipeLayerByRef

void setSwipeLayerByRef(IARLayer ppLayer)
                        throws IOException,
                               AutomationException
The swipe layer used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

IARLayer getSwipeLayer()
                       throws IOException,
                              AutomationException
The swipe layer used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

int getViewWindow()
                  throws IOException,
                         AutomationException
Handle to the view window associated with the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
The window
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

void setMousePointer(int pcursor)
                     throws IOException,
                            AutomationException
The mouse cursor displayed over the document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

int getMousePointer()
                    throws IOException,
                           AutomationException
The mouse cursor displayed over the document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A com.esri.arcgis.controls.esriARMousePointer constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedARLayer

IARLayer getSelectedARLayer()
                            throws IOException,
                                   AutomationException
The selected ARLayer in the TOC.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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.