|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IMapControl2
Provides access to members that control the MapControl.
The IMapControl2 interface is a starting point for any tasks related to the MapControl, such as setting general appearance, setting map and display properties, adding and managing data layers and map documents, and drawing and tracking shapes.
| Method Summary | |
|---|---|
void |
aboutBox()
Displays a dialog of information about the MapControl. |
void |
addLayer(ILayer layer,
int toIndex)
Adds a layer to the Map's collection of layers at the specified index position. |
void |
addLayerFromFile(String lyrPath,
int toIndex)
Loads a layer file and adds it to the Map's collection of layers at the specified index position. |
void |
addShapeFile(String path,
String fileName)
Adds a shapefile as a layer to the Map. |
void |
centerAt(IPoint centerPoint)
Moves the center of the MapControl to the specified location. |
boolean |
checkMxFile(String fileName)
Checks the specified filename to see if it is a map document that can be loaded into the MapControl. |
void |
clearLayers()
Removes all layers from the Map. |
void |
deleteLayer(int index)
Removes a Layer from the Map's collection of layers at the specified index position. |
void |
drawShape(IGeometry shape,
Object symbol)
Draws a geometry shape on the MapControl. |
void |
drawText(IGeometry pGeometry,
String text,
Object pSymbol)
Draws text along the supplied geometry. |
boolean |
esri_isEnabled()
Indicates whether the MapControl can respond to user generated events. |
void |
esri_setEnabled(boolean enabled)
Indicates whether the MapControl can respond to user generated events. |
void |
flashShape(IGeometry pShape,
int nFlashes,
int flashInterval,
Object symbol)
Flashes a shape on the MapControl, duration is in milliseconds. |
void |
fromMapPoint(IPoint pt,
int[] x,
int[] y)
Converts a point on the Map (in map units) to device co-ordinates (typically pixels). |
IActiveView |
getActiveView()
The active view of the Map contained by the MapControl. |
int |
getAppearance()
The appearance of the MapControl. |
int |
getBackColor()
Background color of the MapControl. |
int |
getBorderStyle()
The border style of the MapControl. |
ITool |
getCurrentTool()
Current active tool for the MapControl. |
IEnvelope |
getExtent()
Current extent of the Map in map units. |
IEnvelope |
getFullExtent()
Rectangular shape that encloses all features of all layers in the Map. |
int |
getHWnd()
Handle to the window associated with the MapControl. |
ILayer |
getLayer(int index)
Layer at the supplied index. |
int |
getLayerCount()
Number of layers in the Map. |
IMap |
getMap()
The Map contained by the MapControl. |
double |
getMapScale()
Scale of the map as a representative fraction. |
int |
getMapUnits()
The geographical units of the map. |
Picture |
getMouseIcon()
Custom mouse icon used if MousePointer is 99. |
int |
getMousePointer()
The mouse pointer displayed over the MapControl. |
double |
getReferenceScale()
Reference scale of the Map as a representative fraction. |
double |
getRotation()
Determines how many degrees the map display is rotated. |
ISpatialReference |
getSpatialReference()
Spatial reference of the Map. |
ITrackCancel |
getTrackCancel()
The object used by the MapControl to check if drawing has been aborted. |
boolean |
isOleDropEnabled()
Indicates if the MapControl will fire events when data is dragged over the control's window. |
boolean |
isShowScrollbars()
Indicates whether or not the Map's scrollbars are visible. |
void |
loadMxFile(String mxPath,
Object mapNameOrIndex,
Object password)
Loads the specified Map from the map document into the MapControl. |
void |
moveLayerTo(int fromIndex,
int toIndex)
Moves a layer within the Map's collection from its current index position to a new index position. |
void |
pan()
Tracks the mouse while panning the MapControl. |
IArray |
readMxMaps(String fileName,
Object password)
Opens a map document specified by the supplied filename and reads the maps into an array object. |
void |
refresh(int phase,
Object layerOrElement,
Object envelope)
Redraws the Map, optionally just redraw specified phases or envelope. |
void |
setAppearance(int appearance)
The appearance of the MapControl. |
void |
setBackColor(int backColor)
Background color of the MapControl. |
void |
setBorderStyle(int borderStyle)
The border style of the MapControl. |
void |
setCurrentToolByRef(ITool pTool)
Current active tool for the MapControl. |
void |
setExtent(IEnvelope extent)
Current extent of the Map in map units. |
void |
setFullExtent(IEnvelope fullExtent)
Rectangular shape that encloses all features of all layers in the Map. |
void |
setMapByRef(IMap pMap)
The Map contained by the MapControl. |
void |
setMapScale(double mapScale)
Scale of the map as a representative fraction. |
void |
setMapUnits(int units)
The geographical units of the map. |
void |
setMouseIconByRef(Picture mouseIcon)
Custom mouse icon used if MousePointer is 99. |
void |
setMousePointer(int mousePointer)
The mouse pointer displayed over the MapControl. |
void |
setOleDropEnabled(boolean enabled)
Indicates if the MapControl will fire events when data is dragged over the control's window. |
void |
setReferenceScale(double referenceScale)
Reference scale of the Map as a representative fraction. |
void |
setRotation(double rotation)
Determines how many degrees the map display is rotated. |
void |
setShowScrollbars(boolean showScrollbars)
Indicates whether or not the Map's scrollbars are visible. |
void |
setSpatialReferenceByRef(ISpatialReference spRef)
Spatial reference of the Map. |
void |
setTrackCancelByRef(ITrackCancel ppTrackCancel)
The object used by the MapControl to check if drawing has been aborted. |
void |
setVisibleRegion(IGeometry rhs1)
The geometry specifying the visible region of the Map. |
IPoint |
toMapPoint(int x,
int y)
Converts a point in device co-ordinates (typically pixels) to a point on the Map (in map units). |
IGeometry |
trackCircle()
Rubber-bands a circle on the MapControl. |
IGeometry |
trackLine()
Rubber-bands a polyline on the MapControl. |
IGeometry |
trackPolygon()
Rubber-bands a polygon on the MapControl. |
IEnvelope |
trackRectangle()
Rubber-bands a rectangle on the MapControl. |
| Method Detail |
|---|
int getHWnd()
throws IOException,
AutomationException
The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd. Many ArcObjects methods and Windows API calls require the hWnd as an argument.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setBackColor(int backColor)
throws IOException,
AutomationException
backColor - The backColor (A COM typedef) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getBackColor()
throws IOException,
AutomationException
Returns or sets the Background Color of the MapControl. Internally the OLE_Color is stored as a long integer where the value may be calculated for any RGB combination as follows:
OLE_Color = (Red) + (Green * 256) + (Blue * 256 * 256)
Where Red, Green and Blue are Long Integers within the range 0 - 255.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setMousePointer(int mousePointer)
throws IOException,
AutomationException
mousePointer - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getMousePointer()
throws IOException,
AutomationException
Use this property when you want to indicate changes in functionality as the mouse pointer passes over the MapControl. The esriPointerArrowHourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.getMouseIcon(),
IMapControl3,
IMapControl4
void setMouseIconByRef(Picture mouseIcon)
throws IOException,
AutomationException
mouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Picture getMouseIcon()
throws IOException,
AutomationException
The MouseIcon property provides a custom icon that is used when the MousePointer property is set to esriPointerArrowHourglass (99).
In most development evironments the control's property pages can be used to load either a cursor (.cur) or icon (.ico) file. A cursor contains a custom 'hotspot' location and can be any size. The 'hotspot' location for an icon file defaults to the center of the icon. This property cannot be used to load animated cursor (.ani) files.
To programatically create an object implementing IPictureDisp there is the win32 function OleLoadPicture or helper methods depending on the development environment.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.getMousePointer(),
IMapControl3,
IMapControl4
void setBorderStyle(int borderStyle)
throws IOException,
AutomationException
borderStyle - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getBorderStyle()
throws IOException,
AutomationException
Returns or sets the border style of a MapControl. By default a border is drawn.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void esri_setEnabled(boolean enabled)
throws IOException,
AutomationException
enabled - The enabled (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean esri_isEnabled()
throws IOException,
AutomationException
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setAppearance(int appearance)
throws IOException,
AutomationException
appearance - A com.esri.arcgis.controls.esriControlsAppearance constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getAppearance()
throws IOException,
AutomationException
Returns or sets the paint style of a MapControl to either Flat or 3D. By default the appearance is flat.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void aboutBox()
throws IOException,
AutomationException
The AboutBox method causes a modal dialog box to display on top of the MapControl, containing information about the version and creation date of the MapControl as well as listing relevant legal and copyright information from ESRI.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setMapByRef(IMap pMap)
throws IOException,
AutomationException
pMap - A reference to a com.esri.arcgis.carto.IMap (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IMap getMap()
throws IOException,
AutomationException
This is the Map CoClass contained within the MapControl. If the Map is replaced the IMapControlEvents2::OnMapReplaced event is triggered.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.getMapScale(),
IMapControl2.getReferenceScale(),
IMapControl2.getSpatialReference(),
IMapControl2.getMapUnits(),
IMapControl3,
IMapControl4
IActiveView getActiveView()
throws IOException,
AutomationException
This is the ActiveView on the Map contained within the MapControl.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getLayerCount()
throws IOException,
AutomationException
Returns the number of layers in the Map that implement IDataLayer. This does not include ICompositeLayer objects.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.clearLayers(),
IMapControl2.moveLayerTo(int, int),
IMapControl2.getLayer(int),
IMapControl3,
IMapControl4,
IMapControl2.deleteLayer(int)
ILayer getLayer(int index)
throws IOException,
AutomationException
index - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IEnvelope getExtent()
throws IOException,
AutomationException
Returns or sets a new envelope which is represents the visible extent of the Map. Setting the Extent property will automatically cause the MapControl to refresh its display.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setExtent(IEnvelope extent)
throws IOException,
AutomationException
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IEnvelope getFullExtent()
throws IOException,
AutomationException
Returns or sets a new envelope object representing the full extent of all the data layers in the Map. The FullExtent property is a shortcut to IDisplayTransformation::Bounds. Setting the FullExtent triggers the IMapControlEvents2::OnFullExtentUpdated event.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setFullExtent(IEnvelope fullExtent)
throws IOException,
AutomationException
fullExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isShowScrollbars()
throws IOException,
AutomationException
If ShowScrollbars is true, the MapControl's internal scrollbars will appear when the Extent property is less than the FullExtent property.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setShowScrollbars(boolean showScrollbars)
throws IOException,
AutomationException
showScrollbars - The showScrollbars (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setVisibleRegion(IGeometry rhs1)
throws IOException,
AutomationException
Sets the MapControl's window to be the shape of the supplied geometry (in map units). Only the parts of the MapControl's layers that fall within the geometry specified will be seen.
rhs1 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ISpatialReference getSpatialReference()
throws IOException,
AutomationException
This property is a shortcut to IMap::SpatialReference. The Map's SpatialReference will be set automatically to match the SpatialReference of the first Layer added to its layer collection. If the first Layer added has no SpatialReference defined, the coordinates in the Layer will be analyzed. If the coordinates range from 0 - 180, the MapControl assumes the layers data is geographic (i.e. contains unprojected coordinates in latitude and longitude) and the SpatialReference will appear as "GCS_Assumed_Geographic_1". If the MapControl cannot determine that the data source is geographic, the current SpatialReference will be "Unknown". The SpatialReference is also "Unknown" if the MapControl contains no data.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.getMapScale(),
IMapControl2.getReferenceScale(),
IMapControl2.getMapUnits(),
IMapControl2.getMap(),
IMapControl3,
IMapControl4
void setSpatialReferenceByRef(ISpatialReference spRef)
throws IOException,
AutomationException
spRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
double getReferenceScale()
throws IOException,
AutomationException
This property is a shortcut to IMap::ReferenceScale and is the scale to which all symbol and text sizes used in the Map will be made relative.
A ReferenceScale set to 0 indicates that no ReferenceScale is set and is the default. When no ReferenceScale is set, the size of any symbols or text on the Map remains the same irrespective of MapScale. When a reference scale is set, the size of any symbols or text on the map changes as the MapScale changes. For example, text labels will get larger if you zoom in to a scale larger than the ReferenceScale and smaller if you zoom out to a scale smaller than the ReferenceScale.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.getMapScale(),
IMapControl2.getSpatialReference(),
IMapControl2.getMapUnits(),
IMapControl2.getMap(),
IMapControl3,
IMapControl4
void setReferenceScale(double referenceScale)
throws IOException,
AutomationException
referenceScale - The referenceScale (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
double getMapScale()
throws IOException,
AutomationException
This property is a shortcut to IMap::MapScale which itself is a shortcut to IDisplayTransformation::ScaleRatio.
MapScale is the relationship between the dimensions of features on a map and the geographic objects they represent on the earth, commonly expressed as a fraction or a ratio. A MapScale of 1/100,000 or 1:100,000 means that one unit of measure on the map equals 100,000 of the same units on the earth. Some common scales are as follows:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.getReferenceScale(),
IMapControl2.getSpatialReference(),
IMapControl2.getMapUnits(),
IMapControl2.getMap(),
IMapControl3,
IMapControl4
void setMapScale(double mapScale)
throws IOException,
AutomationException
mapScale - The mapScale (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ITool getCurrentTool()
throws IOException,
AutomationException
The CurrentTool is the Tool used to interact will the MapControl's display. Always check if a tool is enabled before setting it to the CurrentTool property, otherwise a user will be able to use a tool that is actually disabled.
When the CurrentTool is set the following events occur:
Within an ITool implementation it is recommended that the ITool::Deactivate event returns true. This allows a 'new' CurrentTool to be set, and allows the release of the CurrentTool when an application is shutting down.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setCurrentToolByRef(ITool pTool)
throws IOException,
AutomationException
Always check if a tool is enabled before setting it to the CurrentTool property, otherwise a user will be able to use a tool that is actually disabled.
If pCommand.Enabled = True Then Set PageLayoutControl1.CurrentTool = pCommand End If
When the CurrentTool is set the following events occur:
Note that if the CurrentTool is set to Nothing, the ITool::Deactivate event is not triggered on the 'old' CurrentTool, instead it is forcibly removed. The same behaviour occurs if the PageLayoutControl is killed.
Set PageLayoutControl1.CurrentTool = Nothing
pTool - A reference to a com.esri.arcgis.systemUI.ITool (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void addLayer(ILayer layer,
int toIndex)
throws IOException,
AutomationException
When a Layer is added to the MapControl's layer collection and no index is specified, it is added to the beginning or top of the collection with an index of 0. The numeric index of any other layers in the layer collection increments by one.
When a Layer is added and an index is specified, the numeric index of any other layers in the layer collection will increment by one, except for those layers with an index less than the specified index. The index of these layers will remain the same.
The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.
Use the MoveLayerTo method to change the position of a Layer within the layer collection.
layer - A reference to a com.esri.arcgis.carto.ILayer (in)toIndex - The toIndex (in, optional, pass 0 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.addLayerFromFile(String, int),
IMapControl2.addShapeFile(String, String),
IMapControl3,
IMapControl4
void addLayerFromFile(String lyrPath,
int toIndex)
throws IOException,
AutomationException
When a layer file is added to the MapControl's layer collection and no index is specified, it is added to the beginning or top of the collection with an index of 0. The numeric index of any other layers in the layer collection increments by one.
When a layer file is added and an index is specified, the numeric index of any other layers in the layer collection will increment by one, except for those layers with an index less than the specified index. The index of these layers will remain the same.
The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.
Use the MoveLayerTo method to change the position of a Layer within the layer collection.
lyrPath - The lyrPath (in)toIndex - The toIndex (in, optional, pass 0 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.addLayer(com.esri.arcgis.carto.ILayer, int),
IMapControl2.addShapeFile(String, String),
IMapControl3,
IMapControl4
void clearLayers()
throws IOException,
AutomationException
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.getLayerCount(),
IMapControl2.moveLayerTo(int, int),
IMapControl2.getLayer(int),
IMapControl3,
IMapControl4,
IMapControl2.deleteLayer(int)
void deleteLayer(int index)
throws IOException,
AutomationException
This method is a shortcut to IMap::DeleteLayer.
index - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.clearLayers(),
IMapControl2.getLayerCount(),
IMapControl2.moveLayerTo(int, int),
IMapControl2.getLayer(int),
IMapControl3,
IMapControl4
void moveLayerTo(int fromIndex,
int toIndex)
throws IOException,
AutomationException
The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.
fromIndex - The fromIndex (in)toIndex - The toIndex (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.clearLayers(),
IMapControl2.getLayerCount(),
IMapControl2.getLayer(int),
IMapControl3,
IMapControl4,
IMapControl2.deleteLayer(int)
void loadMxFile(String mxPath,
Object mapNameOrIndex,
Object password)
throws IOException,
AutomationException
Loads an map document into the MapControl. The map document can be an ArcMap document, an ArcMap template or an ArcReader document. Use the CheckMxFile method to determine if the specified map document is a valid map document.
When LoadMXfile is used the user may be prompted for a password; refer to the tables below to determine when this may occur. Additionally, password prompts may be given if accessing MapDocuments using either the MapControl's PropertyPage, ArcMap or ArcReader; the tables also show in what circumstances this will occur.
Loading Map Documents (*.mxd, *.mxt, *.pmf) which reference IMS Services (with and without security)
| Application | No Secure Services MXD/ MXT/ PMF files | Secure Servcies MXD/ MXT/ PMF files | Secure Servcies (password cached) MXD/ MXT files | Secure Servcies (password cached) PMF files |
|---|---|---|---|---|
| MapControl (programmatically) | No Prompt | Prompt | No Prompt | Prompt |
| MapControl (property pages) | No Prompt | Prompt | No Prompt | Prompt |
| ArcMap | No Prompt | Prompt | No Prompt | Prompt |
| ArcReader (PMF files only) | No Prompt | Prompt | N/A | No Prompt |
* The Connection to the Internet server must have the Save User/ Password setting enabled. This can be set, for example, when using Add Internet Server in the Add Layers Dialog. Additionally, in the case of PMF files the ArcPublisher Cache password in PMF file setting must be enabled.
Loading Published Map Files (*.pmf) (with and without password protection)
| Application | PMF with No Password | PMF with Password |
|---|---|---|
| MapControl (programmatically) | No Prompt | Supply in Code |
| MapControl (property pages) | No Prompt | Prompt |
| ArcMap | No Prompt | Prompt |
| ArcReader | No Prompt | Prompt |
mxPath - The mxPath (in)mapNameOrIndex - A Variant (in, optional, pass null if not required)password - A Variant (in, optional, pass null if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.readMxMaps(String, java.lang.Object),
IMapControl2.checkMxFile(String),
IMapControl3,
IMapControl4
void refresh(int phase,
Object layerOrElement,
Object envelope)
throws IOException,
AutomationException
Use the Refresh method to redraw the display. If the Refresh method is used and no arguments are supplied the refresh is based upon the IActiveView::Refresh method.
In all other cases the refresh is based upon the IActiveView::PartialRefresh method. The Refresh method supports the esriViewDrawPhases given below:
0 :esriViewNone
1 :esriViewBackground
2 :esriViewGeography
4 :esriViewGeoSelection
8 :esriViewGraphics
16 :esriViewSelection
32 :esriViewForeground
If the Refresh method is used and no phase argument is supplied, but one of the other arguments is supplied then all phases will be refreshed and the phase value will be 65535. Always supply a phase whenever possible to increase efficiency.
Use the layerOrElement argument to refresh a particular layer or graphic element. Use the envelope argument to refresh only a particular region. For example, if a new graphic is added you may only want to refresh the area surrounding the graphic.
Use the TrackCancel object to set whether users can stop drawing processes by using the escape or spacebar keys or by clicking the mouse.
When selecting features, Refresh must be called twice, once before and once after the selection operation.
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in, optional, pass 65535 if not required)layerOrElement - A Variant (in, optional, pass null if not required)envelope - A Variant (in, optional, pass null if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void pan()
throws IOException,
AutomationException
Pan preserves the MapScale property, but changes the Extent property.
Use the Pan method within the IMapControlEvents2::OnMouseDown event to allow the user to pan contents of the MapControl. The IMapControlEvents2::OnMouseMove event will be triggered during the pan, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during panning to cancel the Pan.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void centerAt(IPoint centerPoint)
throws IOException,
AutomationException
The CenterAt method positions the supplied point in the center of the MapControl. The Extent of the MapControl will change, but the scale will remain the same.
centerPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IEnvelope trackRectangle()
throws IOException,
AutomationException
Use the TrackRectangle method within the IMapControlEvents2::OnMouseDown event to rubberband a user defined rectangle. The IMapControlEvents2::OnMouseMove event will be triggered during the track, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackRectangle.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.trackLine(),
IMapControl2.trackPolygon(),
IMapControl3,
IMapControl2.trackCircle(),
IMapControl4
IGeometry trackPolygon()
throws IOException,
AutomationException
TrackPolygon returns a geometry object that implements IPolygon.
Use the TrackPolygon method within the IMapControlEvents2::OnMouseDown event to rubberband a user defined polygon. The IMapControlEvents2::OnMouseMove event will be triggered during the track, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackPolygon.
Calling ITopologicalOperator::Simplify on the digitized polygon will ensure that it is topologically correct.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.trackRectangle(),
IMapControl2.trackLine(),
IMapControl3,
IMapControl2.trackCircle(),
IMapControl4
IGeometry trackLine()
throws IOException,
AutomationException
TrackLine returns a geometry object that implements IPolyline.
Use the TrackLine method within the IMapControlEvents2::OnMouseDown event to rubberband a user defined line. The IMapControlEvents2::OnMouseMove event will be triggered during the track, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackLine.
Calling ITopologicalOperator::Simplify on the digitized line will ensure that it is topologically correct.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.trackRectangle(),
IMapControl2.trackPolygon(),
IMapControl3,
IMapControl2.trackCircle(),
IMapControl4
IGeometry trackCircle()
throws IOException,
AutomationException
TrackCircle returns a geometry object that implements IPolygon.
Use the TrackCircle method within the IMapControlEvents2::OnMouseDown event to rubberband a user defined Circle. The IMapControlEvents2::OnMouseMove event will be triggered during the track, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackCircle.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.trackRectangle(),
IMapControl2.trackLine(),
IMapControl2.trackPolygon(),
IMapControl3,
IMapControl4
void drawShape(IGeometry shape,
Object symbol)
throws IOException,
AutomationException
Geometry objects implementing IEnvelope, IMultiPatch, IMultiPoint, IPoint, IPolygon and IPolyline are supported.
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)symbol - A Variant (in, optional, pass null if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.flashShape(com.esri.arcgis.geometry.IGeometry, int, int, java.lang.Object),
IMapControl2.drawText(com.esri.arcgis.geometry.IGeometry, String, java.lang.Object),
IMapControl3,
IMapControl4
void flashShape(IGeometry pShape,
int nFlashes,
int flashInterval,
Object symbol)
throws IOException,
AutomationException
Geometry objects implementing IEnvelope, IMultiPatch, IMultiPoint, IPoint, IPolygon and IPolyline are supported.
pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)nFlashes - The nFlashes (in, optional, pass 3 if not required)flashInterval - The flashInterval (in, optional, pass 300 if not required)symbol - A Variant (in, optional, pass null if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.drawText(com.esri.arcgis.geometry.IGeometry, String, java.lang.Object),
IMapControl3,
IMapControl4,
IMapControl2.drawShape(com.esri.arcgis.geometry.IGeometry, java.lang.Object)
void fromMapPoint(IPoint pt,
int[] x,
int[] y)
throws IOException,
AutomationException
The FromMapPoint method takes an input point in MapUnits, and populates two variables with the equivalent control coordinates in pixels.
pt - A reference to a com.esri.arcgis.geometry.IPoint (in)x - The x (in/out: use single element array)y - The y (in/out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.toMapPoint(int, int),
IMapControl3,
IMapControl4
IPoint toMapPoint(int x,
int y)
throws IOException,
AutomationException
ToMapPoint converts a (X,Y) location in pixels to MapUnits.
x - The x (in)y - The y (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl3,
IMapControl4,
IMapControl2.fromMapPoint(com.esri.arcgis.geometry.IPoint, int[], int[])
void addShapeFile(String path,
String fileName)
throws IOException,
AutomationException
When a shapefile is added to the MapControl's layer collection it is added to the beginning or top of the collection with an index of 0. The numeric index of any other layers in the layer collection increments by one.
The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.
Use the MoveLayerTo method to change the position of a Layer within the layer collection.
path - The path (in)fileName - The fileName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.addLayer(com.esri.arcgis.carto.ILayer, int),
IMapControl2.addLayerFromFile(String, int),
IMapControl3,
IMapControl4
void drawText(IGeometry pGeometry,
String text,
Object pSymbol)
throws IOException,
AutomationException
pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)text - The text (in)pSymbol - A Variant (in, optional, pass null if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.flashShape(com.esri.arcgis.geometry.IGeometry, int, int, java.lang.Object),
IMapControl3,
IMapControl4,
IMapControl2.drawShape(com.esri.arcgis.geometry.IGeometry, java.lang.Object)
boolean checkMxFile(String fileName)
throws IOException,
AutomationException
Determines whether the specified map document (*.mxd, *.mxt, *.pmf) is a valid map document and can be loaded into the MapControl. The method verifies the file exists and verifies the file internals conform to an expected storage format. The method does not read and validate the entire contents of the file; use the LoadMxFile to do this.
fileName - The fileName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.readMxMaps(String, java.lang.Object),
IMapControl2.loadMxFile(String, java.lang.Object, java.lang.Object),
IMapControl3,
IMapControl4
IArray readMxMaps(String fileName,
Object password)
throws IOException,
AutomationException
ReadMxMaps creates an array of Map objects from the specified Map Document (ArcMap document, ArcMap template or ArcReader document).
When ReadMXMaps is used the user may be prompted for a password; refer to the tables below to determine when this may occur. Additionally, password prompts may be given if accessing MapDocuments using either the MapControl's PropertyPage, ArcMap or ArcReader; the tables also show in what circumstances this will occur.
Reading Map Documents (*.mxd, *.mxt, *.pmf) which reference IMS Services (with and without security)
| Application | No Secure Services MXD/ MXT/ PMF files | Secure Servcies MXD/ MXT/ PMF files | Secure Servcies (password cached) MXD/ MXT files | Secure Servcies (password cached) PMF files |
|---|---|---|---|---|
| MapControl (programmatically) | No Prompt | Prompt | No Prompt | Prompt |
| MapControl (property pages) | No Prompt | Prompt | No Prompt | Prompt |
| ArcMap | No Prompt | Prompt | No Prompt | Prompt |
| ArcReader (PMF files only) | No Prompt | Prompt | N/A | No Prompt |
* The Connection to the Internet server must have the Save User/ Password setting enabled. This can be set, for example, when using Add Internet Server in the Add Layers Dialog. Additionally, in the case of PMF files the ArcPublisher Cache password in PMF file setting must be enabled.
Reading Published Map Files (*.pmf) (with and without password protection)
| Application | PMF with No Password | PMF with Password |
|---|---|---|
| MapControl (programmatically) | No Prompt | Supply in Code |
| MapControl (property pages) | No Prompt | Prompt |
| ArcMap | No Prompt | Prompt |
| ArcReader | No Prompt | Prompt |
fileName - The fileName (in)password - A Variant (in, optional, pass null if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.checkMxFile(String),
IMapControl2.loadMxFile(String, java.lang.Object, java.lang.Object),
IMapControl3,
IMapControl4
void setOleDropEnabled(boolean enabled)
throws IOException,
AutomationException
enabled - The enabled (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isOleDropEnabled()
throws IOException,
AutomationException
Indicates if the MapControl will accept data dragged from another application and fire the IMapControlEvents2::OnOleDrop event. By default the OleDropEnabled property is set to false.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setRotation(double rotation)
throws IOException,
AutomationException
rotation - The rotation (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
double getRotation()
throws IOException,
AutomationException
This property is a shortcut to IDisplayTransformation::Rotation. The Rotation property controls the rotation of the display, and so the angle data appears inside the Map. The angle of the rotation is measured in degrees. Positive numbers rotate the display counter clockwise and negative numbers clockwise.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getMapUnits()
throws IOException,
AutomationException
This property is a shortcut to IMap::MapUnits.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IMapControl2.getMapScale(),
IMapControl2.getReferenceScale(),
IMapControl2.getSpatialReference(),
IMapControl2.getMap(),
IMapControl3,
IMapControl4
void setMapUnits(int units)
throws IOException,
AutomationException
units - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ITrackCancel getTrackCancel()
throws IOException,
AutomationException
Use the TrackCancel object to enable users to stop drawing processes by using the escape or spacebar keys.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setTrackCancelByRef(ITrackCancel ppTrackCancel)
throws IOException,
AutomationException
ppTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
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 | ||||||||