com.esri.arcgis.editor
Interface IEditEvents2

All Superinterfaces:
EventListener, Serializable
All Known Implementing Classes:
AnnotationEditExtension, CreateFeatureDockWin, DimensionEditExtension, IEditEvents2Adapter, IEditEvents2Proxy, UnplacedAnnotationWindow

public interface IEditEvents2
extends EventListener, Serializable

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

Remarks

As with IEditEvents, always set the event object variable to nothing when the class is destructed to avoid circular reference problems.

When editing geometric network features, different combinations of edit events may be fired depending on the edit that is being performed. The OnVertexAdded event is the fired before the OnCreateFeature, OnChangeFeature and OnDeleteFeature edit events under the following geometric network editing scenarios:

See the IEditEvents interface for a listing of those events that are fired when geometric network features are edited. For more infomation on geometric networks and network features refer to the IGeometricNetwork, INetworkFeature and IFeature interfaces.

When To Use

IEditEvents2 contains a collection of new editor events added at release 8.1. For example, the editor now fires event notifcations whenever an edit sketch vertex is added, deleted, or moved.

For more information on editor events, see IEditEvents.

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 beforeStopEditing(IEditEvents2BeforeStopEditingEvent theEvent)
          Fired before StopEditing happens.
 void beforeStopOperation(IEditEvents2BeforeStopOperationEvent theEvent)
          Called before StopOperation is called.
 void onAbort(IEditEvents2OnAbortEvent theEvent)
          Called when AbortOperation is called.
 void onCurrentZChanged(IEditEvents2OnCurrentZChangedEvent theEvent)
          Called when the CurrentZ changes.
 void onSaveEdits(IEditEvents2OnSaveEditsEvent theEvent)
          Called when edits are saved.
 void onStartOperation(IEditEvents2OnStartOperationEvent theEvent)
          Called when StartOperation is called.
 void onStopOperation(IEditEvents2OnStopOperationEvent theEvent)
          Called when StopOperation is called.
 void onVertexAdded(IEditEvents2OnVertexAddedEvent theEvent)
          Called after a point/vertex is added to the sketch.
 void onVertexDeleted(IEditEvents2OnVertexDeletedEvent theEvent)
          Called after a point is deleted from the sketch.
 void onVertexMoved(IEditEvents2OnVertexMovedEvent theEvent)
          Called after a vertex/point has been moved in the sketch.
 

Method Detail

onCurrentZChanged

void onCurrentZChanged(IEditEvents2OnCurrentZChangedEvent theEvent)
                       throws IOException,
                              AutomationException
Called when the CurrentZ changes.

Remarks

The OnCurrentZChanged event is fired when the value for IEditor::CurrentZ is modified. IEditor::CurrentZ can be altered programmatically or through the Current Z control available under the Editor category in the Customize dialog.

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.

onVertexMoved

void onVertexMoved(IEditEvents2OnVertexMovedEvent theEvent)
                   throws IOException,
                          AutomationException
Called after a vertex/point has been moved in the sketch.

Remarks

OnVertexMoved is fired when the location of a vertex in the edit sketch is modified. If the an edit sketch vertex is modified programmatically, call IEditSketch2::VertexMoved to ensure all clients listening for this event are notified.

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.

onVertexAdded

void onVertexAdded(IEditEvents2OnVertexAddedEvent theEvent)
                   throws IOException,
                          AutomationException
Called after a point/vertex is added to the sketch.

Remarks

When IEditSketch2::VertexAdded is called, all clients listening to IEditEvents2::OnVertexAdded are notified. This may be used to ensure the maximum number of points in a particular sketch is not exceeded, or if vertex attributes need to be set on each vertex when it is added to the edit sketch.

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.

onVertexDeleted

void onVertexDeleted(IEditEvents2OnVertexDeletedEvent theEvent)
                     throws IOException,
                            AutomationException
Called after a point is deleted from the sketch.

Remarks

When IEditSketch2::VertexDeleted is called, all clients listening to IEditEvents2::OnVertexDeleted are notified.

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.

beforeStopEditing

void beforeStopEditing(IEditEvents2BeforeStopEditingEvent theEvent)
                       throws IOException,
                              AutomationException
Fired before StopEditing happens.

Remarks

The BeforeStopEditing event is called before edits are committed or discarded. Use this event to perform any processing of the features before the edits are committed.

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.

onAbort

void onAbort(IEditEvents2OnAbortEvent theEvent)
             throws IOException,
                    AutomationException
Called when AbortOperation is called.

Remarks

OnAbort is called whenever an edit operation is aborted.

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.

onStartOperation

void onStartOperation(IEditEvents2OnStartOperationEvent theEvent)
                      throws IOException,
                             AutomationException
Called when StartOperation is called.

Remarks

OnStartOperation is raised when IEditor::StartOperation is called. The OnStartOperation event is not fired for SketchOperations.

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.

beforeStopOperation

void beforeStopOperation(IEditEvents2BeforeStopOperationEvent theEvent)
                         throws IOException,
                                AutomationException
Called before StopOperation is called.

Remarks

BeforeStopOperation is called before the operation is finished (when the sketch is discarded). Use this event to manipulate the sketch geometry before it is committed.

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.

onStopOperation

void onStopOperation(IEditEvents2OnStopOperationEvent theEvent)
                     throws IOException,
                            AutomationException
Called when StopOperation is called.

Remarks

OnStopOperation is called when the operation is successfully completed. At this point the feature has been created but the edit sketch is still available.

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.

onSaveEdits

void onSaveEdits(IEditEvents2OnSaveEditsEvent theEvent)
                 throws IOException,
                        AutomationException
Called when edits are saved.

Remarks

The OnSaveEdits event is fired whenever a user issues the Save Edits command in the Editor. This event is not raised when a user stops an edit session and chooses to save edits, or if IEditor::StopEditing is called.

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.