LAnnotation::ShowLockedIcon

#include "ltwrappr.h"

virtual L_INT LAnnotation::ShowLockedIcon(bShow=TRUE, uFlags=0)

Enables or disables the displaying of the padlock icon on top the annotation object when it is locked.

Parameters

L_BOOL bShow

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

Value Meaning
TRUE Show the padlock icon on top of locked objects.
FALSE Do not show the padlock icon on top of locked objects.

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 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

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

Comments

A locked object will be displayed with a padlock on top if LAnnotation::ShowLockedIcon has been called with bShow set to TRUE.

Note that this information will not be saved when calling LAnnContainer::Save so you should call LAnnotation::ShowLockedIcon with the desired value after calling any of the annotation loading functions:

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

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to LAnnotation::Lock.

Help Version 21.0.2021.4.8
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help