IEditSketch2 Interface

Provides access to members that access and manipulate the edit sketch.

Product Availability

Available with ArcGIS Desktop.

When To Use

IEditSketch2 extends the functionality of the edit sketch by adding support for making the sketch z-aware and for setting Z values on a vertex as well as managing the current EditSketchExtension. IEditSketch2 also has three functions that fire event notifications when vertices are added, modified, or deleted. For example, whenever a vertex is deleted from an edit sketch, VertexDeleted should be called so that any clients listening for this event can respond.

Members

		Description
	AddPoint	Adds a point to the edit sketch. If allowUndo is true, a new operation will be created.
	CurrentZ	Current Z value for the edit sketch.
	EditSketchExtension	The current edit sketch extension.
	FinishSketch	Completes the current edit sketch.
	FinishSketchPart	Completes a part for the current edit sketch.
	Geometry	Geometry stored in the edit sketch.
	GeometryType	Type of the geometry stored in the edit sketch.
	LastPoint	The last point in the edit sketch.
	MAware	Indicates if the edit sketch geometry will contain Ms.
	ModifySketch	Call to notify listeners that the sketch has been changed.
	Part	The index of the current part of the sketch.
	PartComplete	Indicates whether FinishPart has been called on the edit sketch.
	RefreshSketch	Invalidates the portion of the display that is occupied by the sketch.
	Segment	The index of the current segment of the sketch.
	Vertex	The index of the current vertex of the sketch.
	VertexAdded	Call to notify listeners that a sketch vertex has been added.
	VertexDeleted	Call to notify listeners that a sketch vertex has been deleted.
	VertexMoved	Call to notify listeners that a sketch vertex has been moved.
	ZAware	Indicates if the edit sketch geometry will contain Zs.

Inherited Interfaces

Interfaces	Description
IEditSketch	Provides access to members that access and manipulate the edit sketch.

CoClasses that implement IEditSketch2

CoClasses and Classes	Description
Editor	The Object Editor Extension.

Remarks

The IEditSketch2 interface is on the Editor CoClass.

[C#]

You can get a reference of IEditSketch2 by casting from any other interfaces on the Editor CoClass.

The following code excerpt shows an example of this in C#.

  //You can get app from ICommand :: OnCreate() hook parameter
  UID editorUid = new UIDClass();
  editorUid.Value = "esriEditor.Editor";
  IEditSketch2 editSketch = app.FindExtensionByCLSID(editorUid) as IEditSketch2;

[Visual Basic 6.0]

You can QI (Query Interface) for IEditSketch2 from any other interface on the Editor CoClass.

The following VBA code excerpt shows an example of this.

  Dim pApp As IApplication
  Dim pEditor As IEditor
  Dim pEditSketch2 As IEditSketch2
  Dim pID As New UID

  pID = "esriEditor.Editor"
  Set pApp = Application
  Set pEditor = pApp.FindExtensionByCLSID(pID)
  'QI for IEditSketch2
  Set pEditSketch2 = pEditor

[Visual Basic .NET]

You can get a reference of IEditSketch2 by casting from any other interfaces on the Editor CoClass.

The following code excerpt shows an example of this in VBNet.

'You can get app from ICommand :: OnCreate() hook parameter Dim editorUid As UID = New UIDClass() editorUid.Value = "esriEditor.Editor" Dim editSketch As IEditSketch2 = TryCast(app.FindExtensionByCLSID(editorUid), IEditSketch2)

Send feedback on this page