|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IARControl
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 |
---|
static final int IID6e4eca18_6fb2_4faf_b1d8_82392eca3532
static final int xxDummy
static final java.lang.String IID
static final java.lang.String DISPID__504_PUT_NAME
static final java.lang.String DISPID__504_GET_NAME
static final java.lang.String DISPID__514_PUT_NAME
static final java.lang.String DISPID__514_GET_NAME
static final java.lang.String DISPID__520_PUT_NAME
static final java.lang.String DISPID__520_GET_NAME
static final java.lang.String DISPID__552_NAME
static final java.lang.String DISPID_1_NAME
static final java.lang.String DISPID_2_NAME
static final java.lang.String DISPID_3_NAME
static final java.lang.String DISPID_4_PUTREF_NAME
static final java.lang.String DISPID_4_GET_NAME
static final java.lang.String DISPID_5_GET_NAME
static final java.lang.String DISPID_6_GET_NAME
static final java.lang.String DISPID_7_NAME
static final java.lang.String DISPID_8_GET_NAME
static final java.lang.String DISPID_9_NAME
static final java.lang.String DISPID_10_PUT_NAME
static final java.lang.String DISPID_10_GET_NAME
static final java.lang.String DISPID_11_NAME
static final java.lang.String DISPID_12_NAME
static final java.lang.String DISPID_13_PUT_NAME
static final java.lang.String DISPID_13_GET_NAME
static final java.lang.String DISPID_14_NAME
static final java.lang.String DISPID_15_PUT_NAME
static final java.lang.String DISPID_15_GET_NAME
static final java.lang.String DISPID_16_PUT_NAME
static final java.lang.String DISPID_16_GET_NAME
static final java.lang.String DISPID_17_GET_NAME
static final java.lang.String DISPID_18_PUT_NAME
static final java.lang.String DISPID_18_GET_NAME
static final java.lang.String DISPID_19_NAME
static final java.lang.String DISPID_20_GET_NAME
static final java.lang.String DISPID_21_GET_NAME
static final java.lang.String DISPID_21_PUTREF_NAME
static final java.lang.String DISPID_22_GET_NAME
static final java.lang.String DISPID_23_GET_NAME
static final java.lang.String DISPID_23_PUT_NAME
static final java.lang.String DISPID_24_NAME
static final java.lang.String DISPID_25_GET_NAME
static final java.lang.String DISPID_26_NAME
static final java.lang.String DISPID_27_PUT_NAME
static final java.lang.String DISPID_27_GET_NAME
static final java.lang.String DISPID_28_GET_NAME
static final java.lang.String DISPID_28_PUT_NAME
static final java.lang.String DISPID_29_GET_NAME
static final java.lang.String DISPID_30_GET_NAME
static final java.lang.String DISPID_31_GET_NAME
static final java.lang.String DISPID_32_GET_NAME
static final java.lang.String DISPID_33_GET_NAME
static final java.lang.String DISPID_34_GET_NAME
static final java.lang.String DISPID_35_PUTREF_NAME
static final java.lang.String DISPID_35_GET_NAME
static final java.lang.String DISPID_36_GET_NAME
static final java.lang.String DISPID_37_PUT_NAME
static final java.lang.String DISPID_37_GET_NAME
static final java.lang.String DISPID_38_GET_NAME
Method Detail |
---|
void setBorderStyle(int pstyle) throws java.io.IOException, AutomationException
pstyle
- A com.esri.arcgis.controls.esriARBorderStyle constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getBorderStyle() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void esri_setEnabled(boolean pbool) throws java.io.IOException, AutomationException
pbool
- The pbool (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean esri_isEnabled() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setAppearance(int pappearance) throws java.io.IOException, AutomationException
pappearance
- A com.esri.arcgis.controls.esriARAppearance constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getAppearance() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void aboutBox() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void loadDocument(java.lang.String sFilename, java.lang.String sPassword) throws java.io.IOException, AutomationException
sFilename
- The sFilename (in)sPassword
- The sPassword (in, optional, pass if not required)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void unloadDocument() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void reloadDocument(java.lang.String sPassword) throws java.io.IOException, AutomationException
sPassword
- The sPassword (in, optional, pass if not required)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCurrentViewByRef(java.lang.Object ppCurrentView) throws java.io.IOException, AutomationException
ppCurrentView
- A reference to another Automation Object (IDispatch) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.Object getCurrentView() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getDocumentComment() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IARPageLayout getARPageLayout() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void showARWindow(int win, boolean show, java.lang.Object data) throws java.io.IOException, AutomationException
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isARWindowVisible(int win) throws java.io.IOException, AutomationException
win
- A com.esri.arcgis.controls.esriARWindows constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void suppressResizeDrawing(boolean suppressResize, int resizeHWnd) throws java.io.IOException, AutomationException
suppressResize
- The suppressResize (in)resizeHWnd
- The resizeHWnd (in, optional, pass 0 if not required)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTOCWidth(int lWidth) throws java.io.IOException, AutomationException
lWidth
- The lWidth (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getTOCWidth() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void printView() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void copyViewToClipboard() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCurrentARTool(int tool) throws java.io.IOException, AutomationException
tool
- A com.esri.arcgis.controls.esriARTool constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getCurrentARTool() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean hasDocumentPermission(int docPermission) throws java.io.IOException, AutomationException
docPermission
- A com.esri.arcgis.controls.esriARDocumentPermissions constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setShowScrollbars(int viewType, boolean show) throws java.io.IOException, AutomationException
viewType
- A com.esri.arcgis.controls.esriARViewType constant (in)show
- The show (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isShowScrollbars(int viewType) throws java.io.IOException, AutomationException
viewType
- A com.esri.arcgis.controls.esriARViewType constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTOCVisible(boolean visible) throws java.io.IOException, AutomationException
visible
- The visible (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isTOCVisible() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getHWnd() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setShowMapTips(boolean show) throws java.io.IOException, AutomationException
show
- The show (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isShowMapTips() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void refresh(boolean refreshNow) throws java.io.IOException, AutomationException
refreshNow
- The refreshNow (in, optional, pass false if not required)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getCurrentViewType() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IARConfiguration getARConfiguration() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setARConfigurationByRef(IARConfiguration ppConfiguration) throws java.io.IOException, AutomationException
ppConfiguration
- A reference to a com.esri.arcgis.controls.IARConfiguration (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IARUnitConverter getARUnitConverter() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getDocumentFilename() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDocumentFilename(java.lang.String bsFilename) throws java.io.IOException, AutomationException
bsFilename
- The bsFilename (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean checkDocument(java.lang.String sFilename) throws java.io.IOException, AutomationException
sFilename
- The sFilename (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IARCommandInfo getARCommandInfo(int tool) throws java.io.IOException, AutomationException
tool
- A com.esri.arcgis.controls.esriARTool constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void exportView(int format, java.lang.String sFilename) throws java.io.IOException, AutomationException
format
- A com.esri.arcgis.controls.esriARExportFormat constant (in)sFilename
- The sFilename (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEnableFileDrop(boolean pvbValue) throws java.io.IOException, AutomationException
pvbValue
- The pvbValue (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isEnableFileDrop() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.Object getCustomProperty() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCustomProperty(java.lang.Object pVal) throws java.io.IOException, AutomationException
pVal
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.Object getObject() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getViewTop() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getViewLeft() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getViewHeight() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getViewWidth() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isHasCustomARConfiguration() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setSwipeLayerByRef(IARLayer ppLayer) throws java.io.IOException, AutomationException
ppLayer
- A reference to a com.esri.arcgis.controls.IARLayer (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IARLayer getSwipeLayer() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getViewWindow() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setMousePointer(int pcursor) throws java.io.IOException, AutomationException
pcursor
- A com.esri.arcgis.controls.esriARMousePointer constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getMousePointer() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IARLayer getSelectedARLayer() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |