LAnnotation::SetSelected

#include "ltwrappr.h"

virtual L_INT LAnnotation::SetSelected(bSelected=TRUE, uFlags=0)

L_BOOL bSelected;

/* flag that indicates whether to select or deselect an object */

L_UINT uFlags;

/* flags that determine which objects to process */

Selects or deselects the annotation object. This function is available in the Document/Medical Toolkits.

Parameter

Description

bSelected

Flag that indicates whether to select or deselect an object.  Possible values are:

 

Value

Meaning

 

TRUE

Select the specified object and all objects that it contains.

 

FALSE

Deselect the object and all objects that it contains.

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.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function applies to multiple and selected objects based on values of the uFlags parameter.

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:

Class Members, LAnnotation::GetFillMode, LAnnotation::SetFillMode, LAnnotation::GetOptions, LAnnotation::SetOptions, LAnnotation::GetRotateOptions, LAnnotation::SetRotateOptions

Topics:

Annotation Functions: Using Window Coordinates to Select Objects

 

Annotation Functions: Object Information

 

Displaying and Manipulating Annotation Objects

Example

For an example, refer to LAnnotation::GetTag.