L_AnnSetOffsetY

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetOffsetY(hObject, dOffsetY, uFlags)

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.

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_DOUBLE dOffsetY

The new value of the Y 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.

Returns

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

Comments

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

Platforms

Win32, x64.

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

LEADTOOLS Raster Imaging C API Help