com.esri.arcgis.editor
Interface IEditEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

AnnotationEditExtension, CreateFeatureDockWin, DimensionEditExtension, EditSelectionCache, FeatureSnap, IEditEventsAdapter, IEditEventsProxy, UnplacedAnnotationWindow

public interface IEditEvents
extends EventListener, Serializable

Provides access to editor events. Implement it to listen for specific events that occur during an edit session.

Remarks

When editing geometric network features, different combinations of edit events may be fired depending on the edit that is being performed. For more infomation on geometric networks and network features refer to the IGeometricNetwork, INetworkFeature and IFeature interfaces. The following is a breakdown of when the OnCreateFeature, OnChangeFeature and OnDeleteFeature edit events are fired for specific geometric network editing scenarios. The events are listed in the order in which they are fired.

A standalone junction created:

• OnCreatefeature event is fired for junction

A junction is created, snapped along a complex edge:

• OnChangefeature event is fired for complex edge
• OnCreatefeature event is fired for junction

A junction is created, snapped along a simple edge:

• OnCreatefeature event is fired for each new simple edge
• OnDeletefeature event is fired for deleted simple edge
• OnCreatefeature event is fired for junction

A junction subsumes an orphan junction connected to an edge(s):

• OnChangefeature event is fired for each connected edge
• OnDeletefeature event is fired for orphan junction
• OnCreatefeature event is fired for junction

An edge is created:

• OnCreatefeature event is fired twice for each orphan junction
• OnCreatefeature event is fired for new edge

An edge is created which with a connectivity rule (IConnectivityRule) that has a default junction specified:

• OnCreatefeature event is fired twice for each orphan junction
• OnCreatefeature event is fired twice for each default junction
• OnCreatefeature event is fired for new edge

A junction is moved (may or may not have connected edge(s)):

• OnChangefeature event is fired for junction
• OnChangefeature event is fired each connected edge(s)

An endpoint orphan junction is deleted:

• OnDeletefeature event is fired for each connected edge
• OnDeletefeature event is fired for junction

An endpoint junction is deleted:

• OnChangefeature event is fired for each connected edge
• OnDeletefeature event is fired for junction
• OnCreatefeature event is fired for orphan junction

A midspan orphan junction is deleted:

• OnChangefeature event is fired for complex edge
• OnDeletefeature event is fired for orphan junction

A midspan junction is deleted:

• OnChangefeature event is fired twice for complex edge
• OnDeletefeature event is fired for junction
• OnCreatefeature event is fired for Orphan junction

An edge is deleted:

• OnDeletefeature event is fired for edge

When To Use

Edit events are specific notifications that occur during editing. Edit event listeners are objects like a command that listen for and respond to edit events. For example, a specific edit event is fired each time a new feature is created and a custom object could perform automatic feature validation after receiving this notification.

Product Availability

Available with ArcGIS Desktop.

See Also:

ISnapEnvironment, IEditProperties, IEditTask.activate(com.esri.arcgis.editor.IEditor, com.esri.arcgis.editor.IEditTask), IEditor, IEditLayers, IEditTask.deactivate(), IEditAttributeProperties, IEditTask.onFinishSketch(), IEditEvents2, IDatasetEdit, IDatasetEditInfo, IEditTask.onDeleteSketch(), IEditTask.getName(), IEditEvents, Editor, IEditSketch

Method Summary

void	afterDrawSketch(IEditEventsAfterDrawSketchEvent theEvent) Called after the edit sketch is drawn.
void	onChangeFeature(IEditEventsOnChangeFeatureEvent theEvent) Called when features are modified.
void	onConflictsDetected(IEditEventsOnConflictsDetectedEvent theEvent) Called when editing conflicts are detected during save.
void	onCreateFeature(IEditEventsOnCreateFeatureEvent theEvent) Called when new features are created.
void	onCurrentLayerChanged(IEditEventsOnCurrentLayerChangedEvent theEvent) Called when the current layer changes.
void	onCurrentTaskChanged(IEditEventsOnCurrentTaskChangedEvent theEvent) Called when the current task changes.
void	onDeleteFeature(IEditEventsOnDeleteFeatureEvent theEvent) Called when features are deleted.
void	onRedo(IEditEventsOnRedoEvent theEvent) Called when RedoOperation is called.
void	onSelectionChanged(IEditEventsOnSelectionChangedEvent theEvent) Called when the selection changes.
void	onSketchFinished(IEditEventsOnSketchFinishedEvent theEvent) Called when the edit sketch is finished.
void	onSketchModified(IEditEventsOnSketchModifiedEvent theEvent) Called when the edit sketch is modified.
void	onStartEditing(IEditEventsOnStartEditingEvent theEvent) Called when editing begins.
void	onStopEditing(IEditEventsOnStopEditingEvent theEvent) Called when editing ends.
void	onUndo(IEditEventsOnUndoEvent theEvent) Called when UndoOperation is called.

Method Detail

onSelectionChanged

void onSelectionChanged(IEditEventsOnSelectionChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Called when the selection changes.

Remarks

Whenever the feature selection status changes during an edit session, the OnSelectionChanged event is fired. Whenever the selection changes the location of the editor's SelectionAnchor is updated; if the AuxiliarySelectionAnchor is visible then its location is updated also.

When To Use

Use IEditEvents::OnSelectionChanged to execute code immediately after a change in the status of the feature selection. In the attached Visual Basic class module example, the methodology for tapping into the editor events is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCurrentLayerChanged

void onCurrentLayerChanged(IEditEventsOnCurrentLayerChangedEvent theEvent)
                           throws IOException,
                                  AutomationException

Called when the current layer changes.

Remarks

Whenever the current layer changes during an edit session, the OnCurrentLayerChanged event is fired.

When To Use

Use IEditEvents::OnCurrentLayerChanged to execute code immediately after the user changes to another layer. In the attached Visual Basic class module example, the methodology for tapping into the editor events is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCurrentTaskChanged

void onCurrentTaskChanged(IEditEventsOnCurrentTaskChangedEvent theEvent)
                          throws IOException,
                                 AutomationException

Called when the current task changes.

Remarks

Whenever the current task changes during an edit session, the OnCurrentTaskChanged event is fired.

When To Use

Use IEditEvents::OnCurrentTaskChanged to execute code immediately after the user changes to a different task. In the attached Visual Basic class module example, the methodology for tapping into the editor events is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSketchModified

void onSketchModified(IEditEventsOnSketchModifiedEvent theEvent)
                      throws IOException,
                             AutomationException

Called when the edit sketch is modified.

Remarks

Whenever sketch vertices are deleted, added, or moved during an edit session, the OnSketchModified is fired.

When To Use

Use IEditEvents::OnSketchModified to execute code immediately after the user adds, deletes, or moves a vertex in an edit sketch. In the attached Visual Basic class module example, the methodology for tapping into the editor events is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSketchFinished

void onSketchFinished(IEditEventsOnSketchFinishedEvent theEvent)
                      throws IOException,
                             AutomationException

Called when the edit sketch is finished.

Remarks

Whenever a sketch is completed during an edit session, the OnSketchFinished event is fired.

When To Use

Use IEditEvents::OnSketchFinished to execute code immediately after the user activates the IEditSketch::FinishSketch method to complete creation of a feature in an edit sketch. In the attached Visual Basic class module example, the methodology for tapping into the editor events is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterDrawSketch

void afterDrawSketch(IEditEventsAfterDrawSketchEvent theEvent)
                     throws IOException,
                            AutomationException

Called after the edit sketch is drawn.

Remarks

Whenever the edit sketch is refreshed during an edit session, the AfterDrawSketch event is fired.

When To Use

Use IEditEvents::AfterdrawSketch to execute code immediately after the sketch-graphics are refreshed. In the attached Visual Basic class module example, the methodology for tapping into the editor events is shown.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStartEditing

void onStartEditing(IEditEventsOnStartEditingEvent theEvent)
                    throws IOException,
                           AutomationException

Called when editing begins.

Remarks

Whenever an edit session is started, the OnStartEditing event is fired.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStopEditing

void onStopEditing(IEditEventsOnStopEditingEvent theEvent)
                   throws IOException,
                          AutomationException

Called when editing ends.

Remarks

Whenever an edit session ends, the OnStopEditing event is fired.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onConflictsDetected

void onConflictsDetected(IEditEventsOnConflictsDetectedEvent theEvent)
                         throws IOException,
                                AutomationException

Called when editing conflicts are detected during save.

Remarks

Whenever conflicts are detected after a Save Edits or reconcile operation, the OnConflictsDetected event is fired.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onUndo

void onUndo(IEditEventsOnUndoEvent theEvent)
            throws IOException,
                   AutomationException

Called when UndoOperation is called.

Remarks

Whenever an edit operation is undone, the OnUndo event is fired. For example, if a feature is moved and Undo is called, the OnUndo is fired. This event is not fired when sketch operations are undone. For example, undoing the addition of a point to the edit sketch does not trigger the OnUndo event.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRedo

void onRedo(IEditEventsOnRedoEvent theEvent)
            throws IOException,
                   AutomationException

Called when RedoOperation is called.

Remarks

Whenever an edit operation is redone, the OnRedo event is fired. For example, if a feature is moved and Undo and Redo are called, the OnUndo and OnRedo events are fired. This event is not fired when sketch operations are redone. For example, redoing the addition of a point to the edit sketch does not trigger the OnRedo event.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreateFeature

void onCreateFeature(IEditEventsOnCreateFeatureEvent theEvent)
                     throws IOException,
                            AutomationException

Called when new features are created.

Remarks

Whenever a new feature is created the OnCreateFeature event is fired. The new feature is passed to all listening clients via the IObject parameter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChangeFeature

void onChangeFeature(IEditEventsOnChangeFeatureEvent theEvent)
                     throws IOException,
                            AutomationException

Called when features are modified.

Remarks

Whenever a new feature is changed the OnChangeFeature event is fired. The changed feature is passed to all listening clients via the IObject parameter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDeleteFeature

void onDeleteFeature(IEditEventsOnDeleteFeatureEvent theEvent)
                     throws IOException,
                            AutomationException

Called when features are deleted.

Remarks

Whenever a new feature is deleted the OnDeleteFeature event is fired. The deleted feature is passed to all listening clients via the IObject parameter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.