L_AnnSetRestrictToContainer (original) (raw)
Summary
Restricts one or more annotation objects to a container.
Syntax
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnSetRestrictToContainer(hObject, bRestrict, uFlags)
Parameters
HANNOBJECT hObject
Handle to the annotation object
L_BOOL bRestrict
Boolean value that specifies whether to restrict the object to the container. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Restrict the object to the container. |
| FALSE | Do not restrict the object to the container. |
L_UINT uFlags
Flags that determine which objects to process. Possible values are:
| 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_BACKGROUNDCOLOR menu item has been selected. |
Returns
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Comments
If an object is restricted to the container, then no part of that object can be moved outside of the container using automation.
All annotation objects support restriction.
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.
See Also
Functions
- L_AnnDefine
- L_AnnAddUserHandle
- L_AnnAdjustPoint
- L_AnnChangeUserHandle
- L_AnnConvert
- L_AnnDefine2
- L_AnnDeleteUserHandle
- L_AnnEnumerateHandles
- L_AnnGetRestrictToContainer
- L_AnnGetRotateAngle
- L_AnnGetUserHandle
- L_AnnGetUserHandles
- L_AnnRestrictCursor
- L_AnnRestrictCursor
- L_AnnSetAutoSnapCursor
- L_AnnGetAutoSnapCursor
Topics
- Annotation Functions: Creating and Deleting Annotations
- Implementing Custom Annotations
- Implementing Annotations
- Implementing an Automated Annotation Program
- Implementing a Non-automated Annotation Program
- Altering Annotation Object Settings
Example
This example toggles the "restrict to container" property of the annotation to the container.
If an object is restricted to the container, no part of it can be moved outside the container.
L_INT AnnSetRestrictToContainerExample(HANNOBJECT hObject)
{
L_INT nRet;
L_BOOL bRestrict;
nRet = L_AnnGetRestrictToContainer(hObject, &bRestrict);
if (nRet != SUCCESS)
return nRet;
bRestrict = !bRestrict;
L_AnnSetRestrictToContainer(hObject, bRestrict, 0);
_tprintf(_T("%s"), bRestrict ? TEXT("Restricted to container") : TEXT("Not restricted to container"));
return SUCCESS;
}
LEADTOOLS Raster Imaging C API Help