com.esri.arcgis.controls
Interface IEngineEditEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

IEngineEditEventsAdapter, IEngineEditEventsProxy

public interface IEngineEditEvents
extends EventListener, Serializable

Provides access to the EngineEditor's events.

Description

This interface is new at ArcGIS 9.3.

Implement IEngineEditEvents to listen for specific events that occur during an edit session.

The following code example creates a listener to determine when an editing session has started. For more information refer to the "How to listen to edit events" and "How to wire ArcObjects.NET events" documents.

Product Availability

Available with ArcGIS Engine.

Method Summary

void	onAbort(IEngineEditEventsOnAbortEvent theEvent) Fires when an edit operation is aborted.
void	onAfterDrawSketch(IEngineEditEventsOnAfterDrawSketchEvent theEvent) Fires after the edit sketch is drawn.
void	onBeforeStopEditing(IEngineEditEventsOnBeforeStopEditingEvent theEvent) Fires before editing stops.
void	onBeforeStopOperation(IEngineEditEventsOnBeforeStopOperationEvent theEvent) Fires before an edit operation stops.
void	onChangeFeature(IEngineEditEventsOnChangeFeatureEvent theEvent) Fires when features are modified.
void	onConflictsDetected(IEngineEditEventsOnConflictsDetectedEvent theEvent) Fires when editing conflicts are detected during save.
void	onCreateFeature(IEngineEditEventsOnCreateFeatureEvent theEvent) Fires when new features are created.
void	onCurrentTaskChanged(IEngineEditEventsOnCurrentTaskChangedEvent theEvent) Fires when the current task changes.
void	onCurrentZChanged(IEngineEditEventsOnCurrentZChangedEvent theEvent) Called when the CurrentZ changes.
void	onDeleteFeature(IEngineEditEventsOnDeleteFeatureEvent theEvent) Fires when features are deleted.
void	onSaveEdits(IEngineEditEventsOnSaveEditsEvent theEvent) Fires when edits are saved.
void	onSelectionChanged(IEngineEditEventsOnSelectionChangedEvent theEvent) Fires when the selection changes.
void	onSketchFinished(IEngineEditEventsOnSketchFinishedEvent theEvent) Fires when the edit sketch is finished.
void	onSketchModified(IEngineEditEventsOnSketchModifiedEvent theEvent) Fires when the edit sketch is modified.
void	onStartEditing(IEngineEditEventsOnStartEditingEvent theEvent) Fires when editing begins.
void	onStartOperation(IEngineEditEventsOnStartOperationEvent theEvent) Fires when an edit operation starts.
void	onStopEditing(IEngineEditEventsOnStopEditingEvent theEvent) Fires when editing ends.
void	onStopOperation(IEngineEditEventsOnStopOperationEvent theEvent) Fires when an edit operation stops.
void	onTargetLayerChanged(IEngineEditEventsOnTargetLayerChangedEvent theEvent) Fires when the target layer changes.
void	onVertexAdded(IEngineEditEventsOnVertexAddedEvent theEvent) Fires when a vertex is added to the edit sketch.
void	onVertexDeleted(IEngineEditEventsOnVertexDeletedEvent theEvent) Fires when a vertex is deleted from the edit sketch.
void	onVertexMoved(IEngineEditEventsOnVertexMovedEvent theEvent) Fires when a vertex is moved in the edit sketch.

Method Detail

onSelectionChanged

void onSelectionChanged(IEngineEditEventsOnSelectionChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Fires when the selection changes.

Description

The OnSelectionChanged event is fired whenever the feature selection status changes during an edit session.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onTargetLayerChanged

void onTargetLayerChanged(IEngineEditEventsOnTargetLayerChangedEvent theEvent)
                          throws IOException,
                                 AutomationException

Fires when the target layer changes.

Description

The OnTargetLayerChanged event is fired whenever the target layer changes during an edit session. For example, when the IEngineEditLayers::SetTargetLayer method is called programmatically or when the target layer is changed using the ControlsEditingTargetToolControl .

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCurrentTaskChanged

void onCurrentTaskChanged(IEngineEditEventsOnCurrentTaskChangedEvent theEvent)
                          throws IOException,
                                 AutomationException

Fires when the current task changes.

Description

The OnCurrentTaskChanged event is fired whenever the current task changes during an edit session. For example, when a new task from the ControlsEditingTaskToolControl is selected or when the IEngineEditor::CurrentTask is set programmatically.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSketchModified

void onSketchModified(IEngineEditEventsOnSketchModifiedEvent theEvent)
                      throws IOException,
                             AutomationException

Fires when the edit sketch is modified.

Description

The OnSketchModified event is fired whenever sketch vertices are deleted, added, or moved during an edit session.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSketchFinished

void onSketchFinished(IEngineEditEventsOnSketchFinishedEvent theEvent)
                      throws IOException,
                             AutomationException

Fires when the edit sketch is finished.

Description

The OnSketchFinished event is fired whenever a sketch is completed during an edit session. For example, a sketch is finished by double-clicking or by calling IEngineEditSketch::FinishSketch or ControlsEditingSketchFinishCommand programmatically.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onAfterDrawSketch

void onAfterDrawSketch(IEngineEditEventsOnAfterDrawSketchEvent theEvent)
                       throws IOException,
                              AutomationException

Fires after the edit sketch is drawn.

Description

The OnAfterDrawSketch event is fired whenever the edit sketch is modified during an edit session. For example, when a vertex is added to, moved or deleted from the edit sketch. It is also fired when the IEngineEditSketch::RefreshSketch method is called programmatically.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStartEditing

void onStartEditing(IEngineEditEventsOnStartEditingEvent theEvent)
                    throws IOException,
                           AutomationException

Fires when editing begins.

Description

The OnStartEditing event is fired whenever an edit session is started. For example, when the ControlsEditingStartCommand is called or when the IEngineEditor::StartEditing method is called programmatically.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStopEditing

void onStopEditing(IEngineEditEventsOnStopEditingEvent theEvent)
                   throws IOException,
                          AutomationException

Fires when editing ends.

Description

The OnStopEditing event is fired whenever an edit session ends. For example, when the ControlsEditingStopCommand is called or when the IEngineEditor::StopEditing method is called programmatically.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onConflictsDetected

void onConflictsDetected(IEngineEditEventsOnConflictsDetectedEvent theEvent)
                         throws IOException,
                                AutomationException

Fires when editing conflicts are detected during save.

Description

The OnConflictsDetected event is fired whenever conflicts are detected after a Save Edits or reconcile operation.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreateFeature

void onCreateFeature(IEngineEditEventsOnCreateFeatureEvent theEvent)
                     throws IOException,
                            AutomationException

Fires when new features are created.

Description

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

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChangeFeature

void onChangeFeature(IEngineEditEventsOnChangeFeatureEvent theEvent)
                     throws IOException,
                            AutomationException

Fires when features are modified.

Description

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

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDeleteFeature

void onDeleteFeature(IEngineEditEventsOnDeleteFeatureEvent theEvent)
                     throws IOException,
                            AutomationException

Fires when features are deleted.

Description

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

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onVertexMoved

void onVertexMoved(IEngineEditEventsOnVertexMovedEvent theEvent)
                   throws IOException,
                          AutomationException

Fires when a vertex is moved in the edit sketch.

Description

The OnVertexMoved event is fired whenever the location of a vertex in the edit sketch is modified. If the edit sketch vertex is modified programmatically call IEngineEditSketch::VertexMoved to ensure that this event is fired.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onVertexAdded

void onVertexAdded(IEngineEditEventsOnVertexAddedEvent theEvent)
                   throws IOException,
                          AutomationException

Fires when a vertex is added to the edit sketch.

Description

The OnVertexAdded event is fired whenever a new vertex is added to an edit sketch. If the edit sketch vertex is added programmatically call IEngineEditSketch::VertexAdded to ensure that this event is fired. This could be used to check that the maximum number of points in a particular sketch is not exceeded before it is added to the edit sketch.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onVertexDeleted

void onVertexDeleted(IEngineEditEventsOnVertexDeletedEvent theEvent)
                     throws IOException,
                            AutomationException

Fires when a vertex is deleted from the edit sketch.

Description

The OnVertexDeleted event is fired whenever a vertex is deleted from an edit sketch. If the edit sketch vertex is deleted programmatically call IEngineEditSketch::VertexDeleted to ensure that this event is fired.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onBeforeStopEditing

void onBeforeStopEditing(IEngineEditEventsOnBeforeStopEditingEvent theEvent)
                         throws IOException,
                                AutomationException

Fires before editing stops.

Description

The BeforeStopEditing event is fired whenever an edit session ends and before the edits are committed or discarded. Use this event to verify the edit before it is committed.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onAbort

void onAbort(IEngineEditEventsOnAbortEvent theEvent)
             throws IOException,
                    AutomationException

Fires when an edit operation is aborted.

Description

The OnAbort event is fired whenever IEngineEditor::AbortOperation is called.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStartOperation

void onStartOperation(IEngineEditEventsOnStartOperationEvent theEvent)
                      throws IOException,
                             AutomationException

Fires when an edit operation starts.

Description

The OnStartOperation event is fired whenever an edit operation is started or when IEngineEditor::StartOperation is called.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onBeforeStopOperation

void onBeforeStopOperation(IEngineEditEventsOnBeforeStopOperationEvent theEvent)
                           throws IOException,
                                  AutomationException

Fires before an edit operation stops.

Description

OnBeforeStopOperation is fired before the edit operation is finished at which point the sketch is discarded. Use this event to manipulate the sketch geometry before it is committed.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStopOperation

void onStopOperation(IEngineEditEventsOnStopOperationEvent theEvent)
                     throws IOException,
                            AutomationException

Fires when an edit operation stops.

Description

The OnStopOperation event is fired whenever an edit operation is stopped or when IEngineEditor::StopOperation is called. At this stage a feature has been created using the sketch geometry but the IEngineEditSketch::Geometry is still available.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSaveEdits

void onSaveEdits(IEngineEditEventsOnSaveEditsEvent theEvent)
                 throws IOException,
                        AutomationException

Fires when edits are saved.

Description

The OnSaveEdits event is fired when a user calls the ControlsEditingSaveCommand. This event is not fired when a user stops an edit session by executing ControlsEditingStopCommand or calling the IEngineEditor::StopEditing method.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCurrentZChanged

void onCurrentZChanged(IEngineEditEventsOnCurrentZChangedEvent theEvent)
                       throws IOException,
                              AutomationException

Called when the CurrentZ changes.

Description

The OnCurrentZChanged event is fired when the value of IEngineEditSketch::CurrentZ is modified.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.