←Select platform

PushFixedState Method

Summary

Temporarily disables the fixed state of an AnnObject.

Syntax

C++

public virtual int PushFixedState()

  
Public Overridable Function PushFixedState() As Integer

public: 
virtual int PushFixedState();

Return Value

size of the fixed state stack before the call to PushFixedState.

Remarks

This temporarily disables the fixed state of one or more annotations. Fixed annotations are independent of the Transform. The result is that they do not scroll or move with the underlying image. In some instances, however, it is necessary to display a fixed annotation at a larger or smaller size than its fixed size. For example, when printing a fixed annotation, the annotation may need to be painted larger or smaller than normal. To accommodate, call PushFixedState on the fixed AnnObject before the call to print. After the print, call PopFixedState to restore the fixed state of the annotation object.

Typically, you would call PushFixedState/PopFixedState on the root AnnContainer to temporarily disable the fixed state of ALL AnnObject. Calls to PushFixedState and PopFixedState are maintained internally as a stack. This means that nested calls will behave properly. For Example,

PushFixedState(); // Fixed state is temporarily disabled  
PushFixedState(); // Fixed state is temporarily disabled  
PopFixedState(); // Fixed state is still disabled  
PopFixedState(); // Fixed state is enabled

Note that PushFixedState and PopFixedState should always be called in pairs.

The following annotations cannot be fixed:

For more information, refer to SetFixedState. For more information on fixed annotation objects, refer to Fixed Annotations (Deprecated).

Example

For an example, refer to PushFixedState.

Requirements

Target Platforms