LAnnAutomation::SetTextPointerFixed
#include "ltwrappr.h"
virtual L_INT LAnnAutomation::SetTextPointerFixed(bPointerFixed, uFlags)
L_BOOL bPointerFixed; |
/* value that specifies whether the pointer of a Text Pointer object is fixed */ |
L_UINT uFlags; |
/* flags that determine which objects to process */ |
Sets a value that indicates whether the point of any TextPointer object, created using this Automation object, is fixed. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
|
bPointerFixed |
Value that specifies whether the pointer of any TextPointer object, created using this Automation object, is fixed. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
All TextPointer objects created using this automation object will have a fixed pointer. |
|
FALSE |
All TextPointer objects created using this automation object will have a pointer that moves 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 LAnnotation::IsSelected 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. |
|
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
Passing TRUE for bPointerFixed fixes the pointer of any text pointer object created using this automation object. When the text pointer is fixed, the location that the text pointer points to does not change when moving the object (either programmatically or through automation).
Passing FALSE for bPointerFixed frees the pointer of any text pointer object created using this automation object. This means that when the object is moved, the location the text pointer points to moves along with the object.
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. |
See Also
Functions: |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
For an example refer to LAnnAutomation::GetTextPointerFixed.