L_AnnSetTextPointerFixed - Raster Imaging C API Help

L_AnnSetTextPointerFixed

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetTextPointerFixed(hObject, bPointerFixed, uFlags)

HANNOBJECT hObject;

handle to the annotation object to insert

L_BOOL bPointerFixed;

value that specifies whether the pointer of an ANNOBJECT_TEXTPOINTER is fixed

L_UINT uFlags;

flags that determine which objects to process

Sets a value that indicates whether the pointer of an ANNOBJECT_TEXTPOINTER object is fixed.

Parameter Description
hObject Handle to the annotation object.
bPointerFixed Value that specifies whether the pointer of an ANNOBJECT_TEXTPOINTER is fixed. Possible values are:
  Value Meaning
  TRUE Fixes the pointer of an ANNOBJECT_TEXTPOINTER object.
  FALSE Makes the pointer of an ANNOBJECT_TEXTPOINTER move with the object.
 
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 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_TEXT menu item has been selected.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The function is valid only for the ANNOBJECT_TEXTPOINTER annotation object.

Passing TRUE for bPointerFixed fixes the pointer of the text pointer object. When the text pointer is fixed, the location that the text pointer points to does not change when moving the object (either programatically or through automation)

Passing FALSE for bPointerFixed frees the pointer of the text pointer object. This means that when the object is moved, the location the text pointer points to moves along with the object.

Calling this function on an object other the ANNOBJECT_TEXTPOINTER will return ERROR_FEATURE_NOT_SUPPORTED.

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

Win32, x64.

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help