com.esri.arcgis.controls
Interface IARControl

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ArcReaderControl, IARControlProxy

public interface IARControl
extends java.io.Serializable

COM Interface 'IARControl'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members on the control.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID__504_GET_NAME
static java.lang.String	DISPID__504_PUT_NAME
static java.lang.String	DISPID__514_GET_NAME
static java.lang.String	DISPID__514_PUT_NAME
static java.lang.String	DISPID__520_GET_NAME
static java.lang.String	DISPID__520_PUT_NAME
static java.lang.String	DISPID__552_NAME
static java.lang.String	DISPID_1_NAME
static java.lang.String	DISPID_10_GET_NAME
static java.lang.String	DISPID_10_PUT_NAME
static java.lang.String	DISPID_11_NAME
static java.lang.String	DISPID_12_NAME
static java.lang.String	DISPID_13_GET_NAME
static java.lang.String	DISPID_13_PUT_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_15_GET_NAME
static java.lang.String	DISPID_15_PUT_NAME
static java.lang.String	DISPID_16_GET_NAME
static java.lang.String	DISPID_16_PUT_NAME
static java.lang.String	DISPID_17_GET_NAME
static java.lang.String	DISPID_18_GET_NAME
static java.lang.String	DISPID_18_PUT_NAME
static java.lang.String	DISPID_19_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_20_GET_NAME
static java.lang.String	DISPID_21_GET_NAME
static java.lang.String	DISPID_21_PUTREF_NAME
static java.lang.String	DISPID_22_GET_NAME
static java.lang.String	DISPID_23_GET_NAME
static java.lang.String	DISPID_23_PUT_NAME
static java.lang.String	DISPID_24_NAME
static java.lang.String	DISPID_25_GET_NAME
static java.lang.String	DISPID_26_NAME
static java.lang.String	DISPID_27_GET_NAME
static java.lang.String	DISPID_27_PUT_NAME
static java.lang.String	DISPID_28_GET_NAME
static java.lang.String	DISPID_28_PUT_NAME
static java.lang.String	DISPID_29_GET_NAME
static java.lang.String	DISPID_3_NAME
static java.lang.String	DISPID_30_GET_NAME
static java.lang.String	DISPID_31_GET_NAME
static java.lang.String	DISPID_32_GET_NAME
static java.lang.String	DISPID_33_GET_NAME
static java.lang.String	DISPID_34_GET_NAME
static java.lang.String	DISPID_35_GET_NAME
static java.lang.String	DISPID_35_PUTREF_NAME
static java.lang.String	DISPID_36_GET_NAME
static java.lang.String	DISPID_37_GET_NAME
static java.lang.String	DISPID_37_PUT_NAME
static java.lang.String	DISPID_38_GET_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_4_PUTREF_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_7_NAME
static java.lang.String	DISPID_8_GET_NAME
static java.lang.String	DISPID_9_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID6e4eca18_6fb2_4faf_b1d8_82392eca3532
static int	xxDummy Deprecated. Internal use only

Method Summary

void	aboutBox() Displays a dialog of information about the control.
boolean	checkDocument(java.lang.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, java.lang.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.
java.lang.Object	getCurrentView() The current map or page layout view.
int	getCurrentViewType() The type of current view.
java.lang.Object	getCustomProperty() A property to associate data with a control.
java.lang.String	getDocumentComment() A comment about the currently loaded Published Map File (*.PMF).
java.lang.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.
java.lang.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(java.lang.String sFilename, java.lang.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(java.lang.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(java.lang.Object ppCurrentView) The current map or page layout view.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with a control.
void	setDocumentFilename(java.lang.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, java.lang.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.

Field Detail

IID6e4eca18_6fb2_4faf_b1d8_82392eca3532

static final int IID6e4eca18_6fb2_4faf_b1d8_82392eca3532

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID__504_PUT_NAME

static final java.lang.String DISPID__504_PUT_NAME

See Also:

Constant Field Values

DISPID__504_GET_NAME

static final java.lang.String DISPID__504_GET_NAME

See Also:

Constant Field Values

DISPID__514_PUT_NAME

static final java.lang.String DISPID__514_PUT_NAME

See Also:

Constant Field Values

DISPID__514_GET_NAME

static final java.lang.String DISPID__514_GET_NAME

See Also:

Constant Field Values

DISPID__520_PUT_NAME

static final java.lang.String DISPID__520_PUT_NAME

See Also:

Constant Field Values

DISPID__520_GET_NAME

static final java.lang.String DISPID__520_GET_NAME

See Also:

Constant Field Values

DISPID__552_NAME

static final java.lang.String DISPID__552_NAME

See Also:

Constant Field Values

DISPID_1_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_NAME

static final java.lang.String DISPID_3_NAME

See Also:

Constant Field Values

DISPID_4_PUTREF_NAME

static final java.lang.String DISPID_4_PUTREF_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_7_NAME

static final java.lang.String DISPID_7_NAME

See Also:

Constant Field Values

DISPID_8_GET_NAME

static final java.lang.String DISPID_8_GET_NAME

See Also:

Constant Field Values

DISPID_9_NAME

static final java.lang.String DISPID_9_NAME

See Also:

Constant Field Values

DISPID_10_PUT_NAME

static final java.lang.String DISPID_10_PUT_NAME

See Also:

Constant Field Values

DISPID_10_GET_NAME

static final java.lang.String DISPID_10_GET_NAME

See Also:

Constant Field Values

DISPID_11_NAME

static final java.lang.String DISPID_11_NAME

See Also:

Constant Field Values

DISPID_12_NAME

static final java.lang.String DISPID_12_NAME

See Also:

Constant Field Values

DISPID_13_PUT_NAME

static final java.lang.String DISPID_13_PUT_NAME

See Also:

Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME

See Also:

Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_15_PUT_NAME

static final java.lang.String DISPID_15_PUT_NAME

See Also:

Constant Field Values

DISPID_15_GET_NAME

static final java.lang.String DISPID_15_GET_NAME

See Also:

Constant Field Values

DISPID_16_PUT_NAME

static final java.lang.String DISPID_16_PUT_NAME

See Also:

Constant Field Values

DISPID_16_GET_NAME

static final java.lang.String DISPID_16_GET_NAME

See Also:

Constant Field Values

DISPID_17_GET_NAME

static final java.lang.String DISPID_17_GET_NAME

See Also:

Constant Field Values

DISPID_18_PUT_NAME

static final java.lang.String DISPID_18_PUT_NAME

See Also:

Constant Field Values

DISPID_18_GET_NAME

static final java.lang.String DISPID_18_GET_NAME

See Also:

Constant Field Values

DISPID_19_NAME

static final java.lang.String DISPID_19_NAME

See Also:

Constant Field Values

DISPID_20_GET_NAME

static final java.lang.String DISPID_20_GET_NAME

See Also:

Constant Field Values

DISPID_21_GET_NAME

static final java.lang.String DISPID_21_GET_NAME

See Also:

Constant Field Values

DISPID_21_PUTREF_NAME

static final java.lang.String DISPID_21_PUTREF_NAME

See Also:

Constant Field Values

DISPID_22_GET_NAME

static final java.lang.String DISPID_22_GET_NAME

See Also:

Constant Field Values

DISPID_23_GET_NAME

static final java.lang.String DISPID_23_GET_NAME

See Also:

Constant Field Values

DISPID_23_PUT_NAME

static final java.lang.String DISPID_23_PUT_NAME

See Also:

Constant Field Values

DISPID_24_NAME

static final java.lang.String DISPID_24_NAME

See Also:

Constant Field Values

DISPID_25_GET_NAME

static final java.lang.String DISPID_25_GET_NAME

See Also:

Constant Field Values

DISPID_26_NAME

static final java.lang.String DISPID_26_NAME

See Also:

Constant Field Values

DISPID_27_PUT_NAME

static final java.lang.String DISPID_27_PUT_NAME

See Also:

Constant Field Values

DISPID_27_GET_NAME

static final java.lang.String DISPID_27_GET_NAME

See Also:

Constant Field Values

DISPID_28_GET_NAME

static final java.lang.String DISPID_28_GET_NAME

See Also:

Constant Field Values

DISPID_28_PUT_NAME

static final java.lang.String DISPID_28_PUT_NAME

See Also:

Constant Field Values

DISPID_29_GET_NAME

static final java.lang.String DISPID_29_GET_NAME

See Also:

Constant Field Values

DISPID_30_GET_NAME

static final java.lang.String DISPID_30_GET_NAME

See Also:

Constant Field Values

DISPID_31_GET_NAME

static final java.lang.String DISPID_31_GET_NAME

See Also:

Constant Field Values

DISPID_32_GET_NAME

static final java.lang.String DISPID_32_GET_NAME

See Also:

Constant Field Values

DISPID_33_GET_NAME

static final java.lang.String DISPID_33_GET_NAME

See Also:

Constant Field Values

DISPID_34_GET_NAME

static final java.lang.String DISPID_34_GET_NAME

See Also:

Constant Field Values

DISPID_35_PUTREF_NAME

static final java.lang.String DISPID_35_PUTREF_NAME

See Also:

Constant Field Values

DISPID_35_GET_NAME

static final java.lang.String DISPID_35_GET_NAME

See Also:

Constant Field Values

DISPID_36_GET_NAME

static final java.lang.String DISPID_36_GET_NAME

See Also:

Constant Field Values

DISPID_37_PUT_NAME

static final java.lang.String DISPID_37_PUT_NAME

See Also:

Constant Field Values

DISPID_37_GET_NAME

static final java.lang.String DISPID_37_GET_NAME

See Also:

Constant Field Values

DISPID_38_GET_NAME

static final java.lang.String DISPID_38_GET_NAME

See Also:

Constant Field Values

Method Detail

setBorderStyle

void setBorderStyle(int pstyle)
                    throws java.io.IOException,
                           AutomationException

The border style of the control.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBorderStyle

int getBorderStyle()
                   throws java.io.IOException,
                          AutomationException

The border style of the control.

Returns:

A com.esri.arcgis.controls.esriARBorderStyle constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

void esri_setEnabled(boolean pbool)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the control can respond to user generated events.

Parameters:

pbool - The pbool (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException

Indicates whether the control can respond to user generated events.

Returns:

The pbool

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAppearance

void setAppearance(int pappearance)
                   throws java.io.IOException,
                          AutomationException

The appearance of the control.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAppearance

int getAppearance()
                  throws java.io.IOException,
                         AutomationException

The appearance of the control.

Returns:

A com.esri.arcgis.controls.esriARAppearance constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

aboutBox

void aboutBox()
              throws java.io.IOException,
                     AutomationException

Displays a dialog of information about the control.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadDocument

void loadDocument(java.lang.String sFilename,
                  java.lang.String sPassword)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

sFilename - The sFilename (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unloadDocument

void unloadDocument()
                    throws java.io.IOException,
                           AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reloadDocument

void reloadDocument(java.lang.String sPassword)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentViewByRef

void setCurrentViewByRef(java.lang.Object ppCurrentView)
                         throws java.io.IOException,
                                AutomationException

The current map or page layout view.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentView

java.lang.Object getCurrentView()
                                throws java.io.IOException,
                                       AutomationException

The current map or page layout view.

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentComment

java.lang.String getDocumentComment()
                                    throws java.io.IOException,
                                           AutomationException

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

Returns:

The sComment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARPageLayout

IARPageLayout getARPageLayout()
                              throws java.io.IOException,
                                     AutomationException

The page layout contained within the currently loaded document.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showARWindow

void showARWindow(int win,
                  boolean show,
                  java.lang.Object data)
                  throws java.io.IOException,
                         AutomationException

Shows or hides the specified control window.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isARWindowVisible

boolean isARWindowVisible(int win)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the specified control window is visible.

Parameters:

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

Returns:

The visible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

suppressResizeDrawing

void suppressResizeDrawing(boolean suppressResize,
                           int resizeHWnd)
                           throws java.io.IOException,
                                  AutomationException

Suppress full redraw of control during resize operations.

Parameters:

suppressResize - The suppressResize (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTOCWidth

void setTOCWidth(int lWidth)
                 throws java.io.IOException,
                        AutomationException

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

Parameters:

lWidth - The lWidth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTOCWidth

int getTOCWidth()
                throws java.io.IOException,
                       AutomationException

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

Returns:

The lWidth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

printView

void printView()
               throws java.io.IOException,
                      AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copyViewToClipboard

void copyViewToClipboard()
                         throws java.io.IOException,
                                AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentARTool

void setCurrentARTool(int tool)
                      throws java.io.IOException,
                             AutomationException

Current active tool for the control.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentARTool

int getCurrentARTool()
                     throws java.io.IOException,
                            AutomationException

Current active tool for the control.

Returns:

A com.esri.arcgis.controls.esriARTool constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasDocumentPermission

boolean hasDocumentPermission(int docPermission)
                              throws java.io.IOException,
                                     AutomationException

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

Parameters:

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

Returns:

The hasPermission

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowScrollbars

void setShowScrollbars(int viewType,
                       boolean show)
                       throws java.io.IOException,
                              AutomationException

Indicates if the map and page layout scrollbars are visible.

Parameters:

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

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowScrollbars

boolean isShowScrollbars(int viewType)
                         throws java.io.IOException,
                                AutomationException

Indicates if the map and page layout scrollbars are visible.

Parameters:

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

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTOCVisible

void setTOCVisible(boolean visible)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

visible - The visible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTOCVisible

boolean isTOCVisible()
                     throws java.io.IOException,
                            AutomationException

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

Returns:

The visible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws java.io.IOException,
                   AutomationException

Handle to the window associated with the control.

Returns:

The window

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowMapTips

void setShowMapTips(boolean show)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowMapTips

boolean isShowMapTips()
                      throws java.io.IOException,
                             AutomationException

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

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(boolean refreshNow)
             throws java.io.IOException,
                    AutomationException

Refresh the control's window.

Parameters:

refreshNow - The refreshNow (in, optional, pass false if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentViewType

int getCurrentViewType()
                       throws java.io.IOException,
                              AutomationException

The type of current view.

Returns:

A com.esri.arcgis.controls.esriARViewType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARConfiguration

IARConfiguration getARConfiguration()
                                    throws java.io.IOException,
                                           AutomationException

The ARConfiguration used by the control.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setARConfigurationByRef

void setARConfigurationByRef(IARConfiguration ppConfiguration)
                             throws java.io.IOException,
                                    AutomationException

The ARConfiguration used by the control.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARUnitConverter

IARUnitConverter getARUnitConverter()
                                    throws java.io.IOException,
                                           AutomationException

The ARUnitConverter contained by the control.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException

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

Returns:

The bsFilename

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

void setDocumentFilename(java.lang.String bsFilename)
                         throws java.io.IOException,
                                AutomationException

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

Parameters:

bsFilename - The bsFilename (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkDocument

boolean checkDocument(java.lang.String sFilename)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

sFilename - The sFilename (in)

Returns:

The bIsOK

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARCommandInfo

IARCommandInfo getARCommandInfo(int tool)
                                throws java.io.IOException,
                                       AutomationException

The ARCommandInfo contained by the control.

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportView

void exportView(int format,
                java.lang.String sFilename)
                throws java.io.IOException,
                       AutomationException

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

Parameters:

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

sFilename - The sFilename (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableFileDrop

void setEnableFileDrop(boolean pvbValue)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

pvbValue - The pvbValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableFileDrop

boolean isEnableFileDrop()
                         throws java.io.IOException,
                                AutomationException

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

Returns:

The pvbValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

A property to associate data with a control.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Parameters:

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

java.lang.Object getObject()
                           throws java.io.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.

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewTop

int getViewTop()
               throws java.io.IOException,
                      AutomationException

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

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewLeft

int getViewLeft()
                throws java.io.IOException,
                       AutomationException

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

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewHeight

int getViewHeight()
                  throws java.io.IOException,
                         AutomationException

The height of the Active View in pixels.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewWidth

int getViewWidth()
                 throws java.io.IOException,
                        AutomationException

The width of the Active View in pixels.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasCustomARConfiguration

boolean isHasCustomARConfiguration()
                                   throws java.io.IOException,
                                          AutomationException

Is the current PMF using settings stored in the PMF.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSwipeLayerByRef

void setSwipeLayerByRef(IARLayer ppLayer)
                        throws java.io.IOException,
                               AutomationException

The swipe layer used by the control.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSwipeLayer

IARLayer getSwipeLayer()
                       throws java.io.IOException,
                              AutomationException

The swipe layer used by the control.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewWindow

int getViewWindow()
                  throws java.io.IOException,
                         AutomationException

Handle to the view window associated with the control.

Returns:

The window

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMousePointer

void setMousePointer(int pcursor)
                     throws java.io.IOException,
                            AutomationException

The mouse cursor displayed over the document.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMousePointer

int getMousePointer()
                    throws java.io.IOException,
                           AutomationException

The mouse cursor displayed over the document.

Returns:

A com.esri.arcgis.controls.esriARMousePointer constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedARLayer

IARLayer getSelectedARLayer()
                            throws java.io.IOException,
                                   AutomationException

The selected ARLayer in the TOC.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.