LAnnotation::SetAutoBackColor

#include "ltwrappr.h"

virtual L_INT LAnnotation::SetAutoBackColor(uObjectType, crBack)

Sets the background color of one or more annotation objects.

Parameters

L_UINT uObjectType

Type of object for which to change the background color. For a list of possible values, refer to Types of Annotations.

COLORREF crBack

The COLORREF value that specifies the background color.

Returns

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

Comments

This function does not affect objects that do not have this property or that do not let you change the property. For descriptions of the various types of objects and their properties, refer to Types of Annotations. Please note the following:

If uObjectType is then the background color is changed for
ANNOBJECT_NOTE or ANNOBJECT_PUSHPIN Note objects and push pin objects created by the automation object.
ANNOBJECT_HILITE Hilite objects created by the automation object.
ANNOBJECT_REDACT Redact objects created by the automation object.
any other object such as ANNOBJECT_TEXT, ANNOBJECT_RECT, etc. All other objects, created by the automation object, which have a background color property.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to LAnnotation::GetAutoBackColor.

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

LEADTOOLS Raster Imaging C++ Class Library Help