LEADTOOLS Raster imaging C++ Class library help
| LEADTOOLS Raster Imaging C++ Class Library Help > Classes and Member Functions > LAnnotation > LAnnotation Member Functions > LAnnotation::SetOffsetY |
#include "ltwrappr.h"
virtual L_INT LAnnotation::SetOffsetY(dOffsetY, uFlags=0)
|
L_DOUBLE dOffsetY; |
/* the new Y offset */ |
|
L_UINT uFlags; |
/* flags that determine which objects to process */ |
Sets the Y offset of the annotation object.
|
Parameter |
Description |
|
|
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 ( | ). 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 LAnnContainer::GetSelectItems and LAnnotation::SetSelected 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
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Typically, this value is used to match the root container's offset to the offset of the associated bitmap's display rectangle.
The offset values are applied after the scalar properties, which are set by the LAnnotation::SetScalarX and LAnnotation::SetScalarY functions. For more information, refer to Low-Level Coordinate System for Annotations.
This function applies to multiple and selected objects based on values of the uFlags parameter.
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. |
Win32, x64.
See Also
|
Functions: |
|
|
Topics: |
Annotation Functions: Getting and Setting Geometric Properties |
|
|
|
|
|
|
|
|
Example
For an example, refer to LAnnotation::GetOffsetX.
