com.esri.arcgis.editor
Interface IEditLocation

All Superinterfaces:

Serializable

All Known Implementing Classes:

IEditLocationProxy

public interface IEditLocation
extends Serializable

Provides access to the Editor's Location property.

Remarks

This interface was added specifically to allow alternative input of the editor's location property.

Generally, the ::Location() of the editor is set using the current tool via right click(ing) within the display.

However, issues arise when attempting to co-create and show the edit sketch context menu (as an external AO developer). This context menu uses the location of the editor to hit test for a valid geometry. If no valid sketch geometry is found, the context shown will fall back to the default for the display.

Product Availability

Available with ArcGIS Desktop.

See Also:

com.esri.arcgis.editor.IMxDocument, IEditor.getLocation()

Method Summary

IPoint	getLocation() The last known location of the mouse.
void	setLocationByRef(IPoint loc) The last known location of the mouse.

Method Detail

getLocation

IPoint getLocation()
                   throws IOException,
                          AutomationException

The last known location of the mouse.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.editor.IMxDocument, IEditor.getLocation()

setLocationByRef

void setLocationByRef(IPoint loc)
                      throws IOException,
                             AutomationException

The last known location of the mouse.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

loc - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.editor.IMxDocument, IEditor.getLocation()