ArcObjects Library Reference (Controls)

IEngineEditSketch.Segment Property

The index of the current segment of the sketch.

[Visual Basic .NET]
Public ReadOnly Property Segment As Integer

[C#]
public int Segment {get;}

[C++]
HRESULT get_Segment(
  long* Segment
);

[C++]

Parameters
Segment [out, retval]
  Segment is a parameter of type long

Available with ArcGIS Engine.

This property stores the index of the segment of a sketch as specified by the IEngineEditSketch::SetEditLocation method. Once the index has been stored in this property, it remains there until the next time you call the IEngineEditSketch::SetEditLocation method.

Use this property when creating custom commands in a context menu that require the specific sketch segment.

The IEngineEditSketch::SetEditLocation could be called during the IMapControlEvents2::OnMouseUp event to store the index of the segment which the user had clicked on. A value of -1 indicates that no segment has been identified by the IEngineEditSketch::SetEditLocation.