L_AnnSetAutoDefaults

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetAutoDefaults(hAutomation, hObject, uFlags)

HANNOBJECT hAutomation;

handle to the automation object.

HANNOBJECT hObject;

handle to the annotation object.

L_UINT uFlags;

flags that determine which objects to process

Assigns the default properties of the specified automation object to the specified annotation object.

Parameter Description
hAutomation Handle to the automation object.
hObject Handle to the annotation object.
uFlags Flags that determine which objects, referenced by hObject, 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.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function simulates the action that takes place when an annotation object is created using the automated mode. An annotation object created in automated mode receives the same default properties as the automation object, such as foreground color, line width, etc. This lets you assign the same default properties in an automation object to the specified annotation 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.

Platforms

Win32, x64.

See Also

Elements:

L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Altering Annotation Object Settings

Example

L_INT AnnSetAutoDefaultsExample(HWND        hwnd, 
                                                HANNOBJECT  hAutoObject, 
                                                HANNOBJECT  hContainer) 
{ 
   L_INT nRet; 
   ANNRECT     ContainerRect, MyNoteRect, ContainerRectName; 
   RECT        rAnnBounds; 
   RECT        rAnnBoundsName; 
   HANNOBJECT  MyNote; 
   HDC         hWindowDC; 
 
  hWindowDC = GetDC(hwnd); 
  nRet = L_AnnAddUndoNode(hAutoObject); 
  if(nRet != SUCCESS) 
     return nRet; 
  nRet = L_AnnCreateItem(hContainer, ANNOBJECT_NOTE, TRUE, &MyNote); 
  if(nRet != SUCCESS) 
     return nRet; 
  nRet = L_AnnSetAutoDefaults(hAutoObject, MyNote, 0); 
  if(nRet != SUCCESS) 
     return nRet; 
  nRet = L_AnnGetRect(hContainer, &ContainerRect, &ContainerRectName); 
  if(nRet != SUCCESS) 
     return nRet; 
 
  MyNoteRect.left    = ContainerRect.right / 8; 
  MyNoteRect.top     = ContainerRect.bottom / 8; 
  MyNoteRect.right   = ContainerRect.right / 2; 
  MyNoteRect.bottom  = ContainerRect.bottom / 2; 
 
  nRet = L_AnnSetRect(MyNote, &MyNoteRect); 
  if(nRet != SUCCESS) 
     return nRet; 
  nRet = L_AnnGetBoundingRect(MyNote, &rAnnBounds, &rAnnBoundsName); 
  if(nRet != SUCCESS) 
     return nRet; 
  nRet = L_AnnDraw(hWindowDC, &rAnnBounds, MyNote); 
  if(nRet != SUCCESS) 
     return nRet; 
  ValidateRect(hwnd, &rAnnBounds); 
  ReleaseDC(hwnd, hWindowDC); 
   return SUCCESS; 
} 

Help Version 20.0.2018.1.19
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help