In This Topic ▼

L_AnnSetNodes

Summary

Determines which nodes will be shown for those annotation objects that use nodes.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetNodes(hObject, bShowNodes, uGapNodes, uFlags)

Parameters

HANNOBJECT hObject

Handle of the annotation object.

L_BOOL bShowNodes

Flag that indicates whether to show the nodes. Possible values are:

Value	Meaning
TRUE	Show the nodes.
FALSE	Do not show the nodes.

L_UINT uGapNodes

The distance between nodes. Use 0 to display all nodes. This value does not represent the distance in pixels. Instead, it refers to the number of nodes to skip before displaying another node. Possible values are:

Value	Meaning
0	Show every node.
1	Show a node, skip a node, show a node
.
.
.
9	Show a node, skip the next nine
.
.
.	and so on.

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 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_NODES menu item has been selected.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Determines which nodes of the annotation object should display when in design mode.

This function is valid for the following annotation objects:

Curve
Closed Curve
Freehand
Freehand Hotspot
Polygon
Polyline

In addition, the Automation object stores node settings along with the other object default settings

If hObject is a Curve, Closed Curve, Polygon, Polyline, Freehand HotSpot, or Freehand object, this function determines how the nodes for the object will be displayed in design mode.

If hObject is an Automation object, this function determines how the nodes will be displayed for the next Curve, Closed Curve, Polygon, Polyline, Freehand HotSpot, or Freehand object created in automated mode.

If hObject is a Container object, this function determines how the nodes of the Curve, Closed Curve, Polygon, Polylines, Freehand HotSpot, or Freehand objects within the container will be displayed.

If bShowNodes is set to FALSE, uGapNodes will be ignored since the nodes will not be shown anyway.

Note: The last node is always shown. Therefore, using a large value for uGapNodes will probably result in only the first and last nodes being shown.

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

L_INT EXT_CALLBACK SetNodesAnnEnumCallback(HANNOBJECT hObject, L_VOID* pUserData) 
{ 
   UNREFERENCED_PARAMETER(pUserData); 
   L_BOOL   ShowNodes; 
   L_UINT   GapNodes, Type; 
   L_INT    nRet; 
 
   nRet = L_AnnGetType(hObject, &Type); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   switch (Type) 
   { 
   case ANNOBJECT_POLYGON: 
   case ANNOBJECT_POLYLINE: 
   case ANNOBJECT_FREEHAND: 
      nRet = L_AnnGetNodes(hObject, &ShowNodes, &GapNodes); 
      if (nRet != SUCCESS) 
         return nRet; 
 
      if (ShowNodes == L_FALSE) 
         ShowNodes = L_TRUE; 
 
      if (GapNodes != 1) 
         GapNodes = 1; 
 
      nRet = L_AnnSetNodes(hObject, ShowNodes, GapNodes, 0); 
      if (nRet != SUCCESS) 
         return nRet; 
      break; 
 
   default: 
      _tprintf(_T("%s"), TEXT("Notice: This object does not have nodes.")); 
      return FAILURE; 
   } 
 
   return SUCCESS; 
} 
 
L_INT AnnSetNodesExample(HANNOBJECT hContainer) 
{ 
   return L_AnnEnumerate(hContainer, SetNodesAnnEnumCallback, NULL, ANNFLAG_RECURSE | ANNFLAG_SELECTED, NULL); 
}