LAnnotation::GetOptions

#include "ltwrappr.h"

L_INT LAnnotation::GetOptions(puOptions)

L_UINT *puOptions;

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

Gets the currently set user interface and other annotation options.

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 multi-select 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 with the v14 series, new features were disabled by default. To enable these features, call LAnnotation::SetOptions with the desired flags. To get current options, call LAnnotation::GetOptions. For a description of changes prior to this release, refer to Key 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

Win32, x64.

See Also

Functions:

LAnnotation::SetOptions, ANNBUTTON, LAnnToolBar::FreeToolBarButtons, LAnnToolBar::GetToolBarButtons, LAnnToolBar::SetToolBarButtons, LAnnotation::GetFillMode, LAnnotation::SetFillMode, LAnnAutomation::SetAutoCursor, LAnnAutomation::GetAutoCursor, LAnnContainer::Save, LAnnContainer::SaveOffset, LAnnContainer::SaveMemory, LAnnContainer::LoadOffset, LAnnContainer::LoadMemory, LAnnotation::SetTextOptions, LAnnotation::GetTextOptions, LAnnToolBar::Create, LAnnToolBar::GetToolChecked, LAnnToolBar::SetToolChecked, LAnnToolBar::IsButtonVisible, LAnnToolBar::SetButtonVisible, LAnnToolBar::GetToolBarInfo, LAnnToolBar::SetToolBarColumns, LAnnToolBar::SetToolBarRows, LAnnotation::CalibrateRuler

Topics:

Key Annotation Features

 

Calibrating Annotation Ruler Objects

 

Annotation Functions: Displaying Annotations

Example

For an example, refer to LAnnotation::SetOptions.