IEngineSketchOperation.Finish Method

Finishes the sketch operation and puts it into the operation stack. Call this after the sketch has been modified.

[Visual Basic .NET]
Public Sub Finish ( _
    ByVal invalEnv As IEnvelope, _
    ByVal opType As esriEngineSketchOperationType, _
    ByVal Data As Object _
)

[C#]
public void Finish (
    IEnvelope invalEnv,
    esriEngineSketchOperationType opType,
    object Data
);

[C++]
HRESULT Finish(
  IEnvelope* invalEnv,
  esriEngineSketchOperationType opType,
  VARIANT Data
);

[C++]
Parameters
invalEnv [in]
  invalEnv is a parameter of type IEnvelope
opType [in]
  opType is a parameter of type esriEngineSketchOperationType
Data [in]
  Data is a parameter of type VARIANT

Product Availability

Description

The Finish method completes the sketch operation and adds the sketch operation to the top of the operations stack. The method allows tools to give more information about what they modified using the following parameters; InvalEnv, OpType and Data.

InvalEnv determines the envelope that will be invalidated (refreshed) when the sketch operation is completed.  OpType determines which method on IEngineEditSketch will be fired to notify all listeners that the edit sketch has changed and give them appropriate information as to how the edit sketch was modified.  Data is a variant value that can pass an IPoint as an argument to the appropriate method on IEngineEditSketch, such as OnVertexAdded.

See Also