#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetOffsetY(hObject, dOffsetY, uFlags)


handle to the annotation object

L_DOUBLE dOffsetY;

new value of the Y offset

L_UINT uFlags;

flags that determine which objects to process

Sets the Y 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.

Parameter Description
hObject Handle to the annotation object.
dOffsetY The new value of the Y offset.
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.



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


For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.


Win32, x64.See Also


L_AnnSetScalarX, L_AnnSetScalarY, L_AnnGetScalarX, L_AnnGetScalarY, L_AnnSetOffsetX, L_AnnGetOffsetX, L_AnnGetOffsetY, L_AnnGetFixed, L_AnnSetFixed, L_AnnPushFixedState, L_AnnPopFixedState, L_AnnIsFixedInRect


Annotation Functions: Getting and Setting Geometric Properties


Low-Level Coordinate System for Annotations


Implementing an Automated Annotation Program


Implementing a Non-automated Annotation Program


Fixed Annotations


Minimizing Flicker with Double Buffering


Altering Annotation Object Settings


For an example, refer to Implementing a Non-automated Annotation Program or L_AnnSetOffsetX. For complete sample code, refer to the ANNOTATE example.

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

LEADTOOLS Raster Imaging C API Help