LAnnRuler::SetGaugeLength

#include "ltwrappr.h"

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

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

Parameters

L_DOUBLE dLength

The new length of the ruler object's gauge.

L_UINT 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

Value	Meaning
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.

LAnnRuler::SetGaugeLength

#include "ltwrappr.h"

Parameters

L_DOUBLE dLength

L_UINT uFlags

Returns

Comments

Required DLLs and Libraries

Platforms

See Also

Functions

Topics

Example