LAnnotation::SetVisible
#include "ltwrappr.h"
virtual L_INT LAnnotation::SetVisible(bVisible=TRUE, uFlags=0, pUserList=NULL)
|
L_BOOL bVisible; |
/* flag that indicates whether to make the object or objects visible or invisible */ |
|
L_UINT uFlags; |
/* flags that determine which objects to process */ |
|
/* character string that contains the user list */ |
Sets the annotation object to be visible or invisible. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
|
bVisible |
Flag that indicates whether to make the object or objects visible or invisible. Possible values are: |
|
|
|
Value |
Meaning |
|
|
TRUE |
Make the object or objects visible. |
|
|
FALSE |
Make the object or objects invisible. |
|
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_USER |
[0x0040] Process only those objects that have a user included in pUserList. If pUserList is NULL, process only those objects that do not have an associated user. |
|
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
When an object is not visible, it cannot be displayed and functions such as LAnnContainer::HitTest will not detect its presence at a specified position. Some objects (notably containers) may be transparent, but if their visible-object property is TRUE, a user can select them with a mouse.
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: |
|
|
Topics: |
|
|
|
Example
For an example, refer to LAnnotation::CutToClipboard.