LAnnRuler::SetShowFlags

#include "ltwrappr.h"

virtual L_INT LAnnRuler::SetShowFlags(uShowFlags=0, uFlags=0)

L_UINT uShowFlags;	/* flag that indicates how to display the rulers */
L_UINT uFlags;	/* flags that determine which objects to process */

Determines how the Rulers, PolyRulers, Cross-Products, and Protractors created by the automation object will be displayed.

Parameter	Description
uShowFlags	Flag that indicates how to display the rulers. Possible values are:
	Value	Meaning
	0	Display neither the ruler length or the ruler gauge.
	ANNSHOW_LENGTH	Display the ruler length.
	ANNSHOW_GAUGE	Display the ruler gauge.
	ANNSHOW_TICMARKS	Display the tic marks.
uFlags	Flags that determine which objects to process. Most of the flags apply only to container objects. 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 LAnnContainer::GetSelectItems and LAnnotation::SetSelected functions.
	ANNFLAG_NOTTHIS	[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
	ANNFLAG_RECURSE	[0x0008] Process objects within a container, and within any subcontainers, down to any level.
	ANNFLAG_NOTCONTAINER	[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
	ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.
	ANNFLAG_CHECKMENU	[0x0020] Process objects only if the ANNAUTOTEXT_MENU_SHOWRULER menu item has been selected.

Returns

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

Comments

This function determines whether the length and gauge will be shown for the next Ruler, PolyRuler, Cross-Product, or Protractor object created in automated mode.

For Protractor objects, the default value for uShowFlags is 0. For the Ruler, PolyRuler, and Cross-Product objects the default value for uShowFlags is ANNSHOW_LENGTH | ANNSHOW_TICMARKS.

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.

Platforms

Win32, x64.

Functions:	LAnnRuler::GetShowFlags, LAnnotation::CalibrateRuler
Topics:	Annotation Functions: Object Properties
	Annotation Objects - Default Values
	Annotation Objects - Automated Features
	Using Rulers in Annotation Objects
	Key Annotation Features
	Calibrating Annotation Ruler Objects