Sets the X offset of the annotation object. Typically, this value is used to match the root container's offset to the offset of the associated bitmap's display rectangle.


#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetOffsetX(hObject, dOffsetX, uFlags)



Handle to the annotation object.


The new value of the X offset.

L_UINT 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 ( | ).

Note: Normally, you set this property only on the root container. The flags are included only to give you the same level of control as with other properties. 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.


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


The offset values are applied after the scalar properties, which are set by the L_AnnSetScalarX and L_AnnSetScalarY functions. For more information, refer to Low-Level Coordinate System for Annotations.

Required DLLs and Libraries


Win32, x64.

See Also




For another example, refer to Implementing a Non-automated Annotation Program.
For a complete sample code, refer to the \Examples\Annotation\C\Annotate demo.
This example moves all objects down and to the right by changing the container offsets.

L_INT AnnSetOffsetXExample(HANNOBJECT hContainer /* Container annotation object */) 
   L_INT    nRet; 
   L_DOUBLE OffsetX, OffsetY; /* Variables for updating offsets */ 
   ANNRECT  ContainerRect; 
   ANNRECT  ContainerRectName; 
   nRet = L_AnnGetOffsetX(hContainer, &OffsetX); 
   if (nRet != SUCCESS) 
      return nRet; 
   nRet = L_AnnGetOffsetY(hContainer, &OffsetY); 
   if (nRet != SUCCESS) 
      return nRet; 
   /* Get the container rectangle to use for positioning the line */ 
   nRet = L_AnnGetRect(hContainer, &ContainerRect, &ContainerRectName); 
   if (nRet != SUCCESS) 
      return nRet; 
   nRet = L_AnnSetOffsetX(hContainer, OffsetX + ((ContainerRect.right - ContainerRect.left) / 20), 0); 
   if (nRet != SUCCESS) 
      return nRet; 
   return L_AnnSetOffsetY(hContainer, OffsetX + ((ContainerRect.bottom - ContainerRect.top) / 20), 0); 

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.