LAnnPolyRuler::SetTicMarkLength

Show in webframe

#include "ltwrappr.h"

virtual L_INT LAnnPolyRuler::SetTicMarkLength(dLength, uFlags)

L_DOUBLE dLength;	/* new length of the ruler tic marks */
L_UINT uFlags;	/* flags that determine which objects to process */

Sets the length of the tic mark of an ANNOBJECT_RULER or ANNOBJECT_POLYRULER. The tic marks are the perpendicular lines that measure the units.

Parameter	Description
dLength	The new length of the ruler object's tic mark.
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 LAnnotation::IsSelected and LAnnotation::SetSelectedfunctions.
	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_TEXT menu item has been selected.

Returns

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

Comments

The tic mark length applies only to the following annotation objects:

ANNOBJECT_AUTOMATION

ANNOBJECT_RULER

ANNOBJECT_POLYRULER

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

Note that a ruler can have tic marks of different lengths. For example, the ruler shown in the figure below has tic marks with several different lengths. In this case, *pdLength represents the length of the longest tic mark.

$image\Ruler.gif$

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.

See Also

Functions:	Class Members, LAnnotation::CalibrateRuler
Topics:	Annotation Functions: Object Properties
	Implementing Annotations
	Automated User Interface for Annotations
	Annotation Functions: Creating and Deleting Annotations
	Annotation Functions: Working with the Toolbar
	Types of Annotations
	Using Rulers in Annotation Objects
	Key Annotation Features
	Calibrating Annotation Ruler Objects

Example

// This example doubles the length of the tic mark of the pObjec

L_INT LAnnPolyRuler_SetTicMarkLengthExample(LAnnPolyRuler *pObject) 
{
   L_INT nRet =SUCCESS; 
   L_DOUBLE dLength; 
   L_TCHAR szMsg[200]; 
   nRet = pObject->GetTicMarkLength(&dLength); 
 
  if (nRet == SUCCESS) 
   {
      wsprintf(szMsg, TEXT("Old Tic Mark Length: %f\nNew Tic Mark Length %f"),
                                        dLength, 
                                        2 * dLength);
      nRet = pObject->SetTicMarkLength(2 * dLength, 0); 
                if(nRet != SUCCESS)
                        return nRet;
      MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
   }
  return nRet;
}