com.esri.arcgis.controls
Interface IMapControl3

All Superinterfaces:
IMapControl2, java.io.Serializable
All Known Subinterfaces:
IMapControl4
All Known Implementing Classes:
IMapControl3Proxy, IMapControl4Proxy, MapBean, MapControl

public interface IMapControl3
extends IMapControl2, java.io.Serializable

COM Interface 'IMapControl3'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the MapControl.' 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_41_GET_NAME
           
static java.lang.String DISPID_41_PUT_NAME
           
static java.lang.String DISPID_42_NAME
           
static java.lang.String DISPID_43_GET_NAME
           
static java.lang.String DISPID_43_PUT_NAME
           
static java.lang.String DISPID_44_GET_NAME
           
static java.lang.String DISPID_44_PUT_NAME
           
static java.lang.String DISPID_45_GET_NAME
           
static java.lang.String DISPID_46_GET_NAME
           
static java.lang.String DISPID_46_PUT_NAME
           
static java.lang.String DISPID_47_GET_NAME
           
static java.lang.String DISPID_47_PUT_NAME
           
static java.lang.String DISPID_48_GET_NAME
           
static java.lang.String DISPID_48_PUT_NAME
           
static java.lang.String DISPID_49_GET_NAME
           
static java.lang.String DISPID_49_PUT_NAME
           
static java.lang.String IID
          Deprecated. Internal use only
static int IID62c52249_8a87_4f7b_83f1_829064f5438e
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.controls.IMapControl2
DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_GET_NAME, DISPID_1_PUTREF_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_GET_NAME, DISPID_14_PUTREF_NAME, DISPID_15_NAME, DISPID_16_NAME, DISPID_17_NAME, DISPID_18_NAME, DISPID_19_NAME, DISPID_2_GET_NAME, DISPID_20_NAME, DISPID_21_NAME, DISPID_22_NAME, DISPID_23_NAME, DISPID_24_NAME, DISPID_25_NAME, DISPID_26_NAME, DISPID_27_NAME, DISPID_28_NAME, DISPID_29_NAME, DISPID_3_GET_NAME, DISPID_30_NAME, DISPID_31_NAME, DISPID_32_NAME, DISPID_33_NAME, DISPID_34_NAME, DISPID_35_NAME, DISPID_37_GET_NAME, DISPID_37_PUT_NAME, DISPID_38_GET_NAME, DISPID_38_PUT_NAME, DISPID_39_GET_NAME, DISPID_39_PUT_NAME, DISPID_4_GET_NAME, DISPID_40_GET_NAME, DISPID_40_PUTREF_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_PUT_NAME, DISPID_9_GET_NAME, DISPID_9_PUTREF_NAME, IID423dbca0_b7e6_11d5_a9de_00104bb6fc1c
 
Method Summary
 java.lang.Object getCustomProperty()
          A property to associate data with a control.
 java.lang.String getDocumentFilename()
          The filename of the last map document loaded into the control.
 java.lang.String getDocumentMap()
          The name of the map that was last loaded into the control from a map document.
 int getKeyIntercept()
          A property that specifies interception of key strokes that are normally handled by the container.
 java.lang.Object getObject()
          A property that returns the underlying control.
 int getTipDelay()
          The delay before map tips are shown.
 int getTipStyle()
          The style of map tips.
 boolean isShowMapTips()
          Indicates if map tips are shown.
 void setCustomProperty(java.lang.Object pVal)
          A property to associate data with a control.
 void setDocumentFilename(java.lang.String pVal)
          The filename of the last map document loaded into the control.
 void setDocumentMap(java.lang.String pVal)
          The name of the map that was last loaded into the control from a map document.
 void setKeyIntercept(int pVal)
          A property that specifies interception of key strokes that are normally handled by the container.
 void setShowMapTips(boolean show)
          Indicates if map tips are shown.
 void setTipDelay(int delay)
          The delay before map tips are shown.
 void setTipStyle(int style)
          The style of map tips.
 void suppressResizeDrawing(boolean suppressResize, int resizeHWnd)
          Suppress full redraw of control during resize operations.
 
Methods inherited from interface com.esri.arcgis.controls.IMapControl2
aboutBox, addLayer, addLayerFromFile, addShapeFile, centerAt, checkMxFile, clearLayers, deleteLayer, drawShape, drawText, esri_isEnabled, esri_setEnabled, flashShape, fromMapPoint, getActiveView, getAppearance, getBackColor, getBorderStyle, getCurrentTool, getExtent, getFullExtent, getHWnd, getLayer, getLayerCount, getMap, getMapScale, getMapUnits, getMouseIcon, getMousePointer, getReferenceScale, getRotation, getSpatialReference, getTrackCancel, isOleDropEnabled, isShowScrollbars, loadMxFile, moveLayerTo, pan, readMxMaps, refresh, setAppearance, setBackColor, setBorderStyle, setCurrentToolByRef, setExtent, setFullExtent, setMapByRef, setMapScale, setMapUnits, setMouseIconByRef, setMousePointer, setOleDropEnabled, setReferenceScale, setRotation, setShowScrollbars, setSpatialReferenceByRef, setTrackCancelByRef, setVisibleRegion, toMapPoint, trackCircle, trackLine, trackPolygon, trackRectangle
 

Field Detail

IID62c52249_8a87_4f7b_83f1_829064f5438e

static final int IID62c52249_8a87_4f7b_83f1_829064f5438e
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_41_GET_NAME

static final java.lang.String DISPID_41_GET_NAME
See Also:
Constant Field Values

DISPID_41_PUT_NAME

static final java.lang.String DISPID_41_PUT_NAME
See Also:
Constant Field Values

DISPID_42_NAME

static final java.lang.String DISPID_42_NAME
See Also:
Constant Field Values

DISPID_43_GET_NAME

static final java.lang.String DISPID_43_GET_NAME
See Also:
Constant Field Values

DISPID_43_PUT_NAME

static final java.lang.String DISPID_43_PUT_NAME
See Also:
Constant Field Values

DISPID_44_GET_NAME

static final java.lang.String DISPID_44_GET_NAME
See Also:
Constant Field Values

DISPID_44_PUT_NAME

static final java.lang.String DISPID_44_PUT_NAME
See Also:
Constant Field Values

DISPID_45_GET_NAME

static final java.lang.String DISPID_45_GET_NAME
See Also:
Constant Field Values

DISPID_46_PUT_NAME

static final java.lang.String DISPID_46_PUT_NAME
See Also:
Constant Field Values

DISPID_46_GET_NAME

static final java.lang.String DISPID_46_GET_NAME
See Also:
Constant Field Values

DISPID_47_PUT_NAME

static final java.lang.String DISPID_47_PUT_NAME
See Also:
Constant Field Values

DISPID_47_GET_NAME

static final java.lang.String DISPID_47_GET_NAME
See Also:
Constant Field Values

DISPID_48_PUT_NAME

static final java.lang.String DISPID_48_PUT_NAME
See Also:
Constant Field Values

DISPID_48_GET_NAME

static final java.lang.String DISPID_48_GET_NAME
See Also:
Constant Field Values

DISPID_49_GET_NAME

static final java.lang.String DISPID_49_GET_NAME
See Also:
Constant Field Values

DISPID_49_PUT_NAME

static final java.lang.String DISPID_49_PUT_NAME
See Also:
Constant Field Values
Method Detail

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.

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.

getDocumentFilename

java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException
The filename of the last map document loaded into the control.

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

setDocumentFilename

void setDocumentFilename(java.lang.String pVal)
                         throws java.io.IOException,
                                AutomationException
The filename of the last map document loaded into the control.

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

getDocumentMap

java.lang.String getDocumentMap()
                                throws java.io.IOException,
                                       AutomationException
The name of the map that was last loaded into the control from a map document.

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

setDocumentMap

void setDocumentMap(java.lang.String pVal)
                    throws java.io.IOException,
                           AutomationException
The name of the map that was last loaded into the control from a map document.

Parameters:
pVal - The pVal (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.

setShowMapTips

void setShowMapTips(boolean show)
                    throws java.io.IOException,
                           AutomationException
Indicates if map tips are shown.

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.

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

setTipStyle

void setTipStyle(int style)
                 throws java.io.IOException,
                        AutomationException
The style of map tips.

Parameters:
style - A com.esri.arcgis.systemUI.esriTipStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipStyle

int getTipStyle()
                throws java.io.IOException,
                       AutomationException
The style of map tips.

Returns:
A com.esri.arcgis.systemUI.esriTipStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTipDelay

void setTipDelay(int delay)
                 throws java.io.IOException,
                        AutomationException
The delay before map tips are shown.

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

getTipDelay

int getTipDelay()
                throws java.io.IOException,
                       AutomationException
The delay before map tips are shown.

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

getKeyIntercept

int getKeyIntercept()
                    throws java.io.IOException,
                           AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

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

setKeyIntercept

void setKeyIntercept(int pVal)
                     throws java.io.IOException,
                            AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

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