L_AnnGetGrouping

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetGrouping(hObject, pbAutoGroup)

HANNOBJECT hObject;

handle to the container object

L_BOOL *pbAutoGroup;

flags that indicates how objects are grouped

Gets the grouping property of the objects within the specified container.

Parameter

Description

hObject

Handle to the container object.

pbAutoGroup

Pointer to a variable to be updated with a value that indicates whether or not the objects within the specified container are grouped. Possible values are:

 

Value

Meaning

 

TRUE

All objects within the container are treated as a group.

 

FALSE

Each object within the container can be selected and modified independently.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function is valid only for container objects.

Each container contains a "grouping" property, which indicates whether the objects in the container should be treated as a group.

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_AnnSetGrouping, L_AnnGroup, L_AnnUngroup

Topics:

Grouping and Ungrouping Annotation Objects

 

Obtaining Annotation Object Information

Example

This example will toggle grouping for a particular sub-container. The parameter for this function should be a sub-container.

L_INT AnnGetGroupingExample(HANNOBJECT hContainer) 
{ 
   L_INT nRet; 
   L_BOOL bGrouping; 
    
   nRet = L_AnnGetGrouping(hContainer, &bGrouping); 
   if(nRet != SUCCESS) 
      return nRet; 
   nRet = L_AnnSetGrouping(hContainer, !bGrouping, 0); 
   if(nRet != SUCCESS) 
      return nRet; 
   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