L_AnnSetFixed

Show in webframe

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetFixed(hObject, bFixed, bAdjust, uFlags)

HANNOBJECT hObject;	/* handle to the annotation object */
L_BOOL bFixed;	/* value that specifies whether the annotation object is fixed */
L_BOOL bAdjust;	/* value that specifies whether the annotation will be automatically adjusted */
L_UINT uFlags;	/* flags that determine which objects to process */

Sets a value that indicates whether the annotation is fixed.

Parameter	Description
hObject	Handle to the annotation object.
bFixed	Value that specifies whether the annotation object is fixed. Possible values are:
	Value	Meaning
	TRUE	The annotation object is fixed.
	FALSE	The annotation object is not fixed.
bAdjust	Value that specifies whether the annotation will be automatically adjusted when changing the fixed states. Possible values are:
	Value	Meaning
	TRUE	The annotation object is automatically adjusted when changing the fixed state.
	FALSE	The annotation object is not automatically adjusted when changing the fixed state.

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 L_AnnGetSelected and L_AnnSetSelected 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_TEXT menu item has been selected.

Returns

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

Comments

A fixed annotation does not move or change size when the annotation container scalars and offsets are changed. The effect is that the annotation does not move or change size when the underlying image is scrolled or zoomed.

Passing TRUE for the bAdjust parameter automatically adjusts size and location of the object before fixing or un-fixing the annotation object. The result is the annotation object will not jump around as you change its fixed state.

If you pass FALSE for the bAdjust parameter, the annotation object can move or resize if the annotation container has scalar values other than 1, or offset values other than 0. For more information, refer to L_AnnSetScalarX, L_AnnSetScalarY, L_AnnSetOffsetX, and L_AnnSetOffsetY.

The following annotations cannot be fixed:

ANNOBJECT_CONTAINER

ANNOBJECT_REDACT

ANNOBJECT_ENCRYPT

For more information, refer to Fixed Annotations

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_AnnGetFixed, L_AnnIsFixedInRect, L_AnnPopFixedState, L_AnnPushFixedState, L_AnnGetTextFixedSize, L_AnnSetTextFixedSize, L_AnnGetLineFixedWidth, L_AnnSetLineFixedWidth
Topics:	Annotation Functions: Object Properties
	Annotation Objects - Default Values
	Annotation Objects - Automated Features
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Fixed Annotations
	Minimizing Flicker With Double Buffering
	Annotation Functions (Document/Medical only): Getting and Setting the Fixed Property

Example

This Example toggles the "fixed" property of an annotation object. If an object is fixed, it does not move when the underlying image is scrolled or zoomed.

 L_INT AnnSetFixedExample(HANNOBJECT hObject)
{
   L_INT nRet;
   L_BOOL   bFixed;
   L_TCHAR* pszMsg;
   L_TCHAR  szMsg[200];

   nRet = L_AnnGetFixed(hObject, &bFixed);
   if (nRet == SUCCESS)
   {
      bFixed = !bFixed;
      L_AnnSetFixed(hObject, bFixed, TRUE, 0);
      pszMsg = bFixed ? TEXT("Fixed") : TEXT("Not Fixed");
      MessageBox(NULL, pszMsg, TEXT(""), MB_OK);
   }
   else
   {
      wsprintf(szMsg, TEXT("L_AnnGetFixed failed: [%d]"), nRet);
      MessageBox(NULL, szMsg, TEXT("Error"), MB_OK);
      return nRet;
   }
   return SUCCESS;
}