This document is archived and information here might be outdated.  Recommended version.


IEngineEditTask Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Controls)  

IEngineEditTask Interface

Provides access to a task that receives notification when the sketch is complete.

Product Availability

Available with ArcGIS Engine.

Description

This interface is new at ArcGIS 9.3.

The purpose of the IEngineEditTask interface is to take a edit sketch geometry from IEngineEditSketch::Geometry and perform some action on it. Each edit task performs a different operation with this geometry. For example, the CreateNewFeature edit task takes the edit sketch and stores it as a new feature. The EngineEditor can only have one active Engine edit task at a time. Use IEngineEditor::CurrentTask to set this.

All Engine edit tasks implement the IEngineEditTask interface. An engine edit tasks must be registered in the 'ESRI Engine Edit Tasks' component category to appear in the dropdown menu provided by the ControlsEditingTaskToolControl.

Members

Description
Method Activate Notifies the task that the edit sketch is activated.
Method Deactivate Notifies the task that the edit sketch is deactivated.
Read-only property GroupName The group into which the edit task is placed.
Read-only property Name The name of the edit task.
Method OnDeleteSketch Notifies the task that the edit sketch has been deleted.
Method OnFinishSketch Notifies the task that the edit sketch is complete.
Read-only property UniqueName The unique name of the edit task.

Remarks

The out-of-the-box "Create New Feature" and "Modify Feature" engine edit tasks have IEngineEditTask::UniqueName properties of "ControlToolsEditing_CreateNewFeatureTask" and "ControlToolsEditing_ModifyFeatureTask" respectively.

.NET Samples

Cut polygons without selection edit task (Code Files: CutPolygonsWithoutSelectionEditTask) | Editing using a custom form (Code Files: EditorForm) | Custom reshape polyline edit task (Code Files: ReshapePolylineEditTask) | Custom vertex editing commands (Code Files: CustomVertexCommands UsingOutOfBoxVertexCommands) | Feature editing with the control commands (Code Files: FeatureEditing)