LAnnotation::Group

#include "ltwrappr.h"

virtual L_INT LAnnotation::Group(uFlags, pUserList=NULL)

L_UINT uFlags;

/* flags that determine which objects to process */

L_TCHAR * pUserList;

/* list of users */

Groups a number of objects within a container.

Parameter

Description

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 LAnnContainer::GetSelectItems 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_GROUP menu item has been selected.

 

ANNFLAG_USER

[0x0040] Group only those objects with users listed in pUserList.

pUserList

Character string that contains the list of users associated with the specified object. pUserList has the form "User1,User2,,UserN". This must be a NULL terminated string with user names separated by a comma. This parameter is valid only if ANNFLAG_USER is set in uFlags.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The Group automation menu item operates like LAnnotation::Group(ANNFLAG_RECURSE|ANNFLAG_SELECTED|ANNFLAG_CHECKMENU, NULL).

If ANNFLAG_USER is included in uFlags, any user associated with an object to be "grouped" must be included in pUserList. The function checks pUserList before grouping the objects and any object that has a user not in pUserList will not be included in the group.

If ANNFLAG_USER is not included in uFlags, the user list is ignored.

Please note that if you include ANNFLAG_SELECTED|ANNFLAG_USER, for example, in uFlags, the grouped objects must have a user in pUserList AND must also be selected.

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.

See Also

Functions:

LAnnotation::Ungroup

Topics:

Displaying and Manipulating Annotation Objects

Example

//This example uses the following member variables:

//LAnnotationWindow AnnotationWindow

//AnnotationWindow should be created and initialized (using CreateWnd) prior to the example

L_INT LAnnotation_GroupExample(LAnnotationWindow &AnnotationWindow)
{
   LAnnContainer *pAnnContainer;
   pAnnContainer = &(AnnotationWindow.GetContainerObject());
   pAnnContainer->SetUser(NULL, TEXT("Terry"), ANNFLAG_RECURSE | ANNFLAG_SELECTED);
   pAnnContainer->Group(ANNFLAG_SELECTED | ANNFLAG_USER, TEXT("Terry"));
   return SUCCESS;
}