SetFixedState Method

Summary

Sets the fixed state of an AnnObject.

Syntax

C++

public virtual void SetFixedState( 
   bool fixedState, 
   bool adjust 
)

  
Public Overridable Sub SetFixedState( _ 
   ByVal fixedState As Boolean, _ 
   ByVal adjust As Boolean _ 
)

public: 
virtual void SetFixedState(  
   bool fixedState, 
   bool adjust 
)

Parameters

fixedState
true to make the AnnObject fixed; false to allow it to move freely

adjust
true to automatically adjust the AnnObject when changing the fixed state; false to have no adjusting performed.

Remarks

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 AnnObject 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 AnnObject can move or resize if the AnnContainer has a Transform other than the identity matrix.

To fix an annotation object where the size of the font of its text or the width of all pens used to draw it is fixed, use FixedState.

Example

For an example, refer to GetFixedState.

Requirements

Target Platforms