L_AnnGetShowFlags

Summary

Gets a value that indicates how the rulers, cross-products, and protractors will be displayed.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetShowFlags(hObject, puShowFlags)

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_UINT *puShowFlags

Address of the variable to be updated with the value that indicates how the rulers, cross-products, and protractors will be shown. Possible values are:

Value Meaning
0 Do not display the ruler length or the ruler gauge or the tic marks. In this case, the ruler looks like a line.
ANNSHOW_LENGTH Display the ruler length.
ANNSHOW_GAUGE Display the ruler gauge.
ANNSHOW_TICMARKS Display the tic marks.

Returns

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

Comments

This function can only be used for the Ruler, Cross-Product, and Protractor objects. In addition, the Automation object stores show flag settings along with the other object default settings

For Protractor objects, the default value for puShowFlags is 0. For the Ruler, PolyRuler, and Cross-Product objects the default value for puShowFlags is ANNSHOW_LENGTH | ANNSHOW_TICMARKS.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to L_AnnSetShowFlags.

Help Version 22.0.2023.7.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help
Introduction
Version History
Getting Started
Files To Be Included With Your Application
Document Writers – Files To Be Included With Your Application
LEADTOOLS Raster Imaging Features
Quick Reference
Tutorials
Function References
Callback Functions
Summary of Features
Appendix

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.