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


IEngineEditSketch Interface (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IE > IEngineEditSketch Interface (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Controls)  

IEngineEditSketch Interface

Provides access to members that manage the edit sketch.

Product Availability

Available with ArcGIS Engine.

Description

This interface is new at ArcGIS 9.3.

The purpose of the IEngineEditSketch interface is to manage the geometry that will be used by EngineEditor.

The EngineEditor automatically creates a new empty geometry (Geometry) with the same geometry type (GeometryType) as the target layer (IEngineEditLayers::TargetLayer). Use the AddPoint method to create the edit sketch geometry and finishSketch to signal to the current task (IEngineEditor::CurrentTask) that the geometry is ready for use. The current task takes the geometry and performs some action. For example, the Create New Feature task takes the geometry and stores it in the layer as a new feature.

Members

Description
Method AddPoint Adds a point to the edit sketch. If allowUndo is true, a new operation will be created.
Read/write property CurrentZ Current Z value for the edit sketch.
Read-only property EditLocation A point that can be used by any custom editing commands. This property is set by the SetEditLocation method.
Method FinishSketch Completes the current edit sketch.
Method FinishSketchPart Completes a part for the current edit sketch.
Read/write property Geometry Geometry stored in the edit sketch.
Read/write property GeometryType Type of the geometry stored in the edit sketch.
Read-only property LastPoint The last point in the edit sketch.
Method ModifySketch Notifies listeners that the sketch has been changed.
Read-only property Part The index of the current part of the sketch.
Method RefreshSketch Invalidates the portion of the display that is occupied by the sketch.
Read-only property Segment The index of the current segment of the sketch.
Method SetEditLocation Sets the part, segment and vertex of the edit sketch at the x,y location.
Read-only property Vertex The index of the current vertex of the sketch.
Method VertexAdded Notifies listeners that a vertex has been added to the sketch.
Method VertexDeleted Notifies listeners that a vertex has been deleted from the sketch.
Method VertexMoved Notifies listeners that a vertex has been moved in the sketch.
Read/write property ZAware Indicates whether the edit sketch geometry can contain Zs.

CoClasses that implement IEngineEditSketch

CoClasses and Classes Description
EngineEditor A singleton object representing the Engine editing environment.

.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)

.NET Related Topics

How to create a sketch operation