L_AnnGetOptions

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetOption(puOptions)

L_UINT *puOptions;

/* address of the variable to be updated with annotation options */

Gets the currently set user interface and other annotation options . This function is available in the Document/Medical Toolkits.

Parameter

Description

puOptions

Address of the variable to be updated with annotation options. Use a bitwise OR to specify more than one value. Possible values are:

 

Value

Meaning

 

OPTIONS_NEW_STAMP_METAFILES

[0x0001] Uses the new rubber stamp styles.

 

OPTIONS_NEW_TOOLBAR

[0x0002] Displays the new XP style annotation toolbar.

 

OPTIONS_NEW_ALPHA

[0x0004] Displays new "alpha" option in the Fill mode dialog.

 

OPTIONS_NEW_ROTATE

[0x0008] Displays rotate handles on objects in design mode.

 

OPTIONS_NEW_SIDE_HANDLES

[0x0010] Displays side handles on rectangular objects in design mode.

 

OPTIONS_NEW_MULTI_SELECT

[0x0020] Displays a multiselect outline of multiply selected objects, along with the new multi-select resize behavior.

 

OPTIONS_NEW_CURSORS

[0x0040] Displays different cursors for each of the annotation tools, and when hovering over handles in design mode.

 

OPTIONS_NEW_ESC_CANCEL

[0x0080] Allows the user to cancel current action by pressing ESC. Actions include annotation creation and manipulation.

 

OPTIONS_NEW_CALIBRATE_RULER

[0x0100] Enables the ruler calibration feature in design mode.

 

OPTIONS_NEW_DOT_DASH_LINES

[0x0200] Draws the dash and dot line styles with line widths greater than 1 pixel.

 

OPTIONS_NEW_TEXT_OPTIONS

[0x0400] Enables new text annotation options including show/hide text, show/hide border, and changing text color.

 

OPTIONS_NEW_ALL

Enables ALL the new options. The value for this constant is the logical "or" of all the above flags.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Some of these features change the way annotations look. Other features change the behavior of the user interface (automated mode). To maintain backward compatibility, new features are disabled by default. To enable these features, call L_AnnSetOptions with the desired flags. To get the current options, call L_AnnGetOptions. For a description of the changes, refer to Annotation Features.

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

Windows 2000 / XP/Vista.

See Also

Functions:

ANNBUTTON, L_AnnFreeToolBarButtons, L_AnnGetToolBarButtons, L_AnnSetToolBarButtons, L_AnnGetFillMode, L_AnnSetFillMode, L_AnnSetAutoCursor, L_AnnGetAutoCursor, L_AnnSave, L_AnnSaveOffset, L_AnnSaveMemory, L_AnnLoad, L_AnnLoadOffset, L_AnnLoadMemory, L_AnnSetTextOptions, L_AnnGetTextOptions, L_AnnSetOptions

Topics:

Annotation Features.

 

Calibrating Annotation Ruler Objects

 

Annotation Functions (Document/Medical only): Getting and Setting the Alpha Property

Example

For an example, refer to L_AnnSetOptions.