L_AnnSetGaugeLength

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetGaugeLength(hObject, dLength, uFlags)

HANNOBJECT hObject;

/* handle to the annotation automation object */

L_DOUBLE dLength;

/* new length of the ruler object's gauge */

L_UINT uFlags;

/* flags that determine which objects to process */

Sets the length of the gauge (the perpendicular lines at the ends of the Ruler object). This function is available in the Document/Medical Toolkits.

Parameter

Description

hObject

Handle to the annotation automation object.

dLength

The new length of the ruler object's gauge.

uFlags

Flags that determine which objects to process. 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 L_AnnGetSelected and L_AnnSetSelected 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_RULER menu item has been selected.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The gauge length property applies only to Automation 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.

Platforms

Windows 2000 / XP/Vista.

See Also

Functions:

L_AnnSetBitmapDpiX, L_AnnGetBitmapDpiX, L_AnnGetBitmapDpiY, L_AnnSetBitmapDpiY, L_AnnSetUnit, L_AnnGetUnit, L_AnnGetUnitLen, L_AnnGetDistance, L_AnnGetGaugeLength, L_AnnGetTicMarkLength, L_AnnSetTicMarkLength, L_AnnGetDistance2, ANNSMARTDISTANCE

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Altering Annotation Object Settings

 

Using Rulers in Annotation Objects

 

Annotation Features

 

Calibrating Annotation Ruler Objects

Example

 L_INT AnnSetGaugeLengthExample(HANNOBJECT hAnnObject,HANNOBJECT hContainer)
{
   L_INT nRet;
   L_DOUBLE dLength;

   /* if gauge length setting 
   is longer than 5 pixels, then make it 5 pixels. */
   nRet = L_AnnGetGaugeLength(hAnnObject, &dLength);
   if(nRet != SUCCESS)
      return nRet;
   if (dLength > 5.0f)
   {
      nRet = L_AnnSetGaugeLength(hAnnObject, 5.0f, 0);
      if(nRet != SUCCESS)
         return nRet;
      /* make all ruler objects the same. */
      nRet = L_AnnSetGaugeLength(hContainer, 5.0f, ANNFLAG_RECURSE);
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS;
}