In This Topic ▼

LAnnotation::SetRestrictToContainer

Summary

Restricts one or more annotation objects to a container.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnotation::SetRestrictToContainer(bRestrict, uFlags)

Parameters

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. 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_UNGROUP 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.

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 LAnnotation_SetRestrictToContainerExample(LAnnotation * pLObject)  
{ 
   L_INT nRet; 
   L_BOOL bRestrict;  
   L_TCHAR *pszMsg;  
 
   nRet = pLObject->GetRestrictToContainer(&bRestrict);  
   if (nRet == SUCCESS)  
   { 
      bRestrict = !bRestrict;  
      nRet = pLObject->SetRestrictToContainer(bRestrict, 0);  
      if(nRet != SUCCESS) 
         return nRet; 
      pszMsg = bRestrict ? TEXT("Restricted to container") : TEXT("Not restricted to container"); 
      MessageBox(NULL, pszMsg, TEXT(""), MB_OK);  
   } 
   else 
      return nRet; 
 
   return SUCCESS; 
}