LAnnRuler::SetGaugeLength

#include "ltwrappr.h"

virtual L_INT LAnnRuler::SetGaugeLength(dLength, uFlags=0)

L_DOUBLE dLength;	/* the new gauge length */
L_UINT uFlags;	/* flags that determine the object to process */

Sets the length of the gauge (the perpendicular lines at the ends of the Ruler object).

Parameter	Description
dLength	The new length of the ruler object's gauge.
uFlags	Flags that determine the object to process. You can combine values when appropriate by using a bitwise OR ( \| ). The following are valid values:
	Value	Meaning
	0	Process only the specified object.
	ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.
	ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The gauge length property applies only to Automation, PolyRuler, and Ruler objects. Refer to Annotation Automation Object.

dLength is expressed in pixels, not in points. The length is for the whole line, not just from the end point of the ruler to the end point of the gauge - it is from one end of the gauge to the other end of the gauge.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Functions:	Class Members, LAnnPolyRuler::GetDistance2, ANNSMARTDISTANCE, LAnnotation::CalibrateRuler
Topics:	Annotation Functions: Working with the Toolbar
	Implementing Annotations
	Automated User Interface for Annotations
	Using Rulers in Annotation Objects
	Calibrating Annotation Ruler Objects