LAnnRuler::SetFontUnderline

#include "ltwrappr.h"

virtual L_INT LAnnRuler::SetFontUnderline(bFontUnderline=TRUE, uFlags=0)

L_BOOL bFontUnderline;

/* flag that indicates whether to apply or remove an underline */

L_UINT uFlags;

/* flags that determine the object to process */

 

NOTE:

THIS FUNCTION IS NOW INHERITED DIRECTLY FROM THE PARENT LANNOTATION CLASS.

Applies or removes the underline of an annotation object.

Parameter

Description

bFontUnderline

Flag that indicates whether to apply or remove an underline. Possible values are:

 

Value

Meaning

 

TRUE

Apply an underline to the text.

 

FALSE

Remove an underline from the text.

uFlags

Flags that determine the object to process. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

 

Value

Meaning

 

0

Process only the specified object.

 

ANNFLAG_SELECTED

[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.

 

ANNFLAG_NOINVALIDATE

[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

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.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

Example

For an example, refer to LAnnRuler::IsFontUnderline.