ITraverseWindow2 Interface

Provides access to members that interact with the Traverse Window dialog.

Product Availability

Description

ITraverseWindow2 extends the TraverseWindow functionality to allow you to set things like the the start and end points of the traverse, check if the Finish or IsClosed buttons are enabled.

Members

	All Properties Methods	Description
	Add	Add the course that is defined by the current course parameters.
	Course	A reference to the ith course.
	CourseCount	The number of courses in the traverse.
	CourseType	The type of the course being added.
	CurveDirectionType	If the course type is esriCTCurve, defines the direction type of the curve.
	CurveParameter	If the course type is esriCTCurve or esriCTTangentCurve, describes the type of curve paramater that the ith measure text represents.
	Finish	Finishes the traverse.
	FinishPoint	The specified end point of the traverse.
	IsAddEnabled	Indicates if the Add command on the Traverse Window dialog is enabled.
	IsClosedLoop	Indicates if the traverse is a closed loop.
	IsFinishEnabled	Indicates if the Finish command on the Traverse Window dialog is enabled.
	MeasureHWND	The handle of the ith measure text control.
	MeasureSelected	Indicates if the text in the ith measure is selected.
	MeasureText	The ith value that defines the course to add.
	Remove	Removes the ith course from the traverse.
	SetFocusToMeasure	Change the focus to the ith measure text control.
	StartPoint	The specified start point of the traverse.
	TurnDirection	If the course type is esriCTCurve or esriCTTangentCurve, indicates if the curve turns to the left or right.
	Visible	Indicates if Traverse Window is visible.

CoClasses that implement ITraverseWindow2

Remarks

ITraverseWindow2 allows courses to be added to the existing traverse within the Traverse dialog. A current workspace must be being edited for the Traverse dialog to be enabled. Also the current edit layer must be either a Polyline or a Polygon.

A StartPoint needs to be set before any courses can be added. An optional FinishPoint can exist for the traverse.

The type of course being added to the traverse depends on the CourseType. The esriCTDirectionDistance and esriCTAngleDistance courses create line segments, the esriCTCurve and esriCTTangentCurve courses create circular arc segments. The courses are defined by text values within the MeasureText, CurveParameter, CurveDirectionType and TurnDirection properties.

When the course type is DirectionDistance, MeasureText(0) is the direction of the course and MeasureText(1) is the distance of the course. For a course type of AngleDistance, MeasureText(0) is the clockwise angle between the previous segment and the new segment and MeasureText(1) is the distance of the line segment. For both the TangentCurve and Curve course types, MeasureText(0) is a text value representing the appropriate curve parameter defined by CurveParameter(0) and MeasureText(1) is a text value representing the appropriate curve parameter defined by CurveParameter(1). Any two of the CurveParameters are required to create a circular arc including Chord Length, Arc Length, Delta Angle or Radius. The TurnDirection is also required to indicate if the curve turns to the left or right If the course type is Curve, a text value in MeasureText(2) and CurveDirectionType define the direction of the curve.

Once all of the parameters have been set for a course, IsAddEnabled will test if the values are correct. Add is used to create a new course. You can test IsFinishEnabled, the Finish button is enabled once you have at least one course in the traverse. You can also remove a specific course with the Remove method.

All Directions and Angles are in the current units specified within the Editor options. Distances are in the current data frame map units, however they can also be entered with an appropriate suffix that specifies the length units. Refer to the IDistanceConverter for more on the converting distances.

To interact with specific controls on the Traverse Window dialog, the MeasureSelected, MeasureHWND and SetFocusToMeasure methods are used.