com.esri.arcgis.editor
Class CreateFeatureDockWin

java.lang.Object
  com.esri.arcgis.editor.CreateFeatureDockWin

All Implemented Interfaces:

IActiveViewEvents, IEditEvents, IEditEvents2, IAcceleratorHook, IDockableWindowDef, IDockableWindowImageDef, IDockableWindowInitialPlacement, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class CreateFeatureDockWin
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDockableWindowDef, IDockableWindowImageDef, IDockableWindowInitialPlacement, IActiveViewEvents, IEditEvents, IEditEvents2, IAcceleratorHook

Esri create features window.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.framework.IDockableWindowDef

IID, IID3d1fa10a_f154_11d3_a67e_0008c7df97b9, xxDummy

Fields inherited from interface com.esri.arcgis.framework.IDockableWindowImageDef

IID, IID08f4fc5d_c23f_4210_b289_1350ed5632ed, xxDummy

Fields inherited from interface com.esri.arcgis.framework.IDockableWindowInitialPlacement

IID, IID1ec80980_7a02_426d_bd2b_c6d3beb2ed54, xxDummy

Constructor Summary

CreateFeatureDockWin()
Constructs a CreateFeatureDockWin using ArcGIS Engine.

CreateFeatureDockWin(Object obj)
Construct a CreateFeatureDockWin using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	afterDraw(IActiveViewEventsAfterDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterDrawSketch(IEditEventsAfterDrawSketchEvent theEvent) Called after the edit sketch is drawn.
void	afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) Fired after an individual view item is drawn.
void	beforeStopEditing(IEditEvents2BeforeStopEditingEvent theEvent) Fired before StopEditing happens.
void	beforeStopOperation(IEditEvents2BeforeStopOperationEvent theEvent) Called before StopOperation is called.
boolean	checkAccelerator(int vkey) Return true if the framework should carry out the action associated with this virtual key.
void	contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) Fired when the contents of the view changes.
void	contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) Fired when the contents of the view is cleared.
boolean	equals(Object o) Compare this object with another
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
int	getBitmap() Provide a bitmap for dockviews
String	getCaption() The caption of the dockable window.
int	getChildHWND() The hWnd of the window to be embedded in a dockable window.
static String	getClsid() getClsid.
int	getDockPosition() DockPosition
int	getHeight() Height
String	getName() The name of the dockable window.
IUID	getNeighbor() Neighbor
Object	getUserData() User defined data.
int	getWidth() Width
int	hashCode() the hashcode for this object
void	itemAdded(IActiveViewEventsItemAddedEvent theEvent) Fired when an item is added to the view.
void	itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) Fired when an item is deleted from the view.
void	itemReordered(IActiveViewEventsItemReorderedEvent theEvent) Fired when a view item is reordered.
void	onAbort(IEditEvents2OnAbortEvent theEvent) Called when AbortOperation is called.
void	onChangeFeature(IEditEventsOnChangeFeatureEvent theEvent) Called when features are modified.
void	onConflictsDetected(IEditEventsOnConflictsDetectedEvent theEvent) Called when editing conflicts are detected during save.
void	onCreate(Object hook) Occurs when this dockable window is created and provides access to the application.
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	onCurrentZChanged(IEditEvents2OnCurrentZChangedEvent theEvent) Called when the CurrentZ changes.
void	onDeleteFeature(IEditEventsOnDeleteFeatureEvent theEvent) Called when features are deleted.
void	onDestroy() Occurs when the docking window is about to be destroyed.
void	onRedo(IEditEventsOnRedoEvent theEvent) Called when RedoOperation is called.
void	onSaveEdits(IEditEvents2OnSaveEditsEvent theEvent) Called when edits are saved.
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	onStartOperation(IEditEvents2OnStartOperationEvent theEvent) Called when StartOperation is called.
void	onStopEditing(IEditEventsOnStopEditingEvent theEvent) Called when editing ends.
void	onStopOperation(IEditEvents2OnStopOperationEvent theEvent) Called when StopOperation is called.
void	onUndo(IEditEventsOnUndoEvent theEvent) Called when UndoOperation 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.
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
void	viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) Fired when view is refreshed before draw happens.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

CreateFeatureDockWin

public CreateFeatureDockWin()
                     throws IOException,
                            UnknownHostException

Constructs a CreateFeatureDockWin using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CreateFeatureDockWin

public CreateFeatureDockWin(Object obj)
                     throws IOException

Construct a CreateFeatureDockWin using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to CreateFeatureDockWin.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems CreateFeatureDockWin theCreateFeatureDockWin = (CreateFeatureDockWin) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

onCreate

public void onCreate(Object hook)
              throws IOException,
                     AutomationException

Occurs when this dockable window is created and provides access to the application.

Specified by:

onCreate in interface IDockableWindowDef

Parameters:

hook - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildHWND

public int getChildHWND()
                 throws IOException,
                        AutomationException

The hWnd of the window to be embedded in a dockable window.

Specified by:

getChildHWND in interface IDockableWindowDef

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the dockable window.

Specified by:

getName in interface IDockableWindowDef

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCaption

public String getCaption()
                  throws IOException,
                         AutomationException

The caption of the dockable window.

Specified by:

getCaption in interface IDockableWindowDef

Returns:

The caption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDestroy

public void onDestroy()
               throws IOException,
                      AutomationException

Occurs when the docking window is about to be destroyed.

Specified by:

onDestroy in interface IDockableWindowDef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserData

public Object getUserData()
                   throws IOException,
                          AutomationException

User defined data.

Specified by:

getUserData in interface IDockableWindowDef

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBitmap

public int getBitmap()
              throws IOException,
                     AutomationException

Provide a bitmap for dockviews

Specified by:

getBitmap in interface IDockableWindowImageDef

Returns:

The bitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException

Height

Specified by:

getHeight in interface IDockableWindowInitialPlacement

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException

Width

Specified by:

getWidth in interface IDockableWindowInitialPlacement

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDockPosition

public int getDockPosition()
                    throws IOException,
                           AutomationException

DockPosition

Specified by:

getDockPosition in interface IDockableWindowInitialPlacement

Returns:

A com.esri.arcgis.framework.esriDockFlags constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNeighbor

public IUID getNeighbor()
                 throws IOException,
                        AutomationException

Neighbor

Specified by:

getNeighbor in interface IDockableWindowInitialPlacement

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view changes.

Remarks

The Map object fires this event when a new document is loaded. Adding a new layer to a Map does not trigger this event.

The PageLayout object fires the event when IGraphicsContainer::DeleteAllElements in called and when a new document is loaded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

contentsChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IActiveView.contentsChanged()

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

contentsCleared in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws IOException,
                      AutomationException

Fired when an item is added to the view.

Remarks

The Map fires the event every time a new layer is added.

The PageLayout fires this event whenever a new element is added to the layout. Elements include not only graphics but data frames as well.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemAdded in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when an item is deleted from the view.

Remarks

The PageLayout object fires this event whenever elements are deleted from the layout.

The Map object fires this event when a layer is removed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemDeleted in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a view item is reordered.

Remarks

The Map objects only fire this event whenever IMap::MoveLayer is called. In the ArcMap application, this occurs when you reorder layers in the table of contents. The Map will also fire this event when new layers are added.

The PageLayout object fires this event when changing the order of graphics. For example, IGraphicsContainer::BringToFront, PutElementOrder, SendToBack, SendBackward, and BringForward all fire this event. These functions are on ArcMap's Drawing menu under the Order pull right menu. Although the Map object is also a graphics container, it does not fire this event when its graphics are reordered.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemReordered in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws IOException,
                             AutomationException

Call this function to fire the selection changed event.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

selectionChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Description

Method that gets fired in response to IActiveView::Refresh and IActiveView::PartialRefresh.

Remarks

This event is useful in the case where you're watching for something to change in the view and there aren't any specific events for that change (e.g. ContentsChanged, ItemAdded). You can always listen for this method as a last resort. Care must be taken however to be very efficient in your implementation of this event because it will be called quite often.

The event parameters directly coincide with the arguments to IActiveView::PartialRefresh. For additional information about the arguments, see the help for that method.

If the event object connects to both the layout and a map, then the view parameter tells you which object initiated the event.

In an implementation of this method you typically want to check the phase and respond to only one. Otherwise, your code will execute multiple times per drawing sequence.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

viewRefreshed in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws IOException,
                      AutomationException

Fired after the specified phase is drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Remarks

AfterItemDraw can be used to execute after each individual item has drawn. Event firing can be an expensive operation (time consuming) when there are many layers in a map, however. As a result, the AfterItemDraw event is only fired when the IViewManger::VerboseEvents property is set to True. By default this property is False.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterItemDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when a new map is made active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

focusMapChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

spatialReferenceChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public 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

Specified by:

onSelectionChanged in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCurrentLayerChanged

public 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

Specified by:

onCurrentLayerChanged in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCurrentTaskChanged

public 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

Specified by:

onCurrentTaskChanged in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSketchModified

public 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

Specified by:

onSketchModified in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSketchFinished

public 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

Specified by:

onSketchFinished in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterDrawSketch

public 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

Specified by:

afterDrawSketch in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStartEditing

public 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

Specified by:

onStartEditing in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStopEditing

public 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

Specified by:

onStopEditing in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onConflictsDetected

public 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

Specified by:

onConflictsDetected in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onUndo

public 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

Specified by:

onUndo in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRedo

public 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

Specified by:

onRedo in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreateFeature

public 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

Specified by:

onCreateFeature in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChangeFeature

public 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

Specified by:

onChangeFeature in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDeleteFeature

public 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

Specified by:

onDeleteFeature in interface IEditEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCurrentZChanged

public 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

Specified by:

onCurrentZChanged in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onVertexMoved

public 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

Specified by:

onVertexMoved in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onVertexAdded

public 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

Specified by:

onVertexAdded in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onVertexDeleted

public 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

Specified by:

onVertexDeleted in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeStopEditing

public 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

Specified by:

beforeStopEditing in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onAbort

public 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

Specified by:

onAbort in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStartOperation

public 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

Specified by:

onStartOperation in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeStopOperation

public 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

Specified by:

beforeStopOperation in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onStopOperation

public 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

Specified by:

onStopOperation in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSaveEdits

public 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

Specified by:

onSaveEdits in interface IEditEvents2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkAccelerator

public boolean checkAccelerator(int vkey)
                         throws IOException,
                                AutomationException

Return true if the framework should carry out the action associated with this virtual key.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

checkAccelerator in interface IAcceleratorHook

Parameters:

vkey - The vkey (in)

Returns:

The check

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.