LAnnText::SetFontStrikeThrough

#include "ltwrappr.h"

virtual L_INT LAnnText::SetFontStrikeThrough(bFontStrikeThrough=TRUE, uFlags=0)

L_BOOL bFontStrikeThrough;

/* flag that indicates whether to apply or remove the strike-through*/

L_UINT uFlags;

/* flags that determine which objects to process */

 

NOTE:

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

Applies or removes the strike-through (a line through the middle of the text), of an annotation object.

Parameter

Description

bFontStrikeThrough

Flag that indicates whether to apply or remove the strike-through. Possible values are:

 

Value

Meaning

 

TRUE

Apply a strike-through.

 

FALSE

Remove the strike-through.

uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. 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 LAnnContainer::GetSelectItems() 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 LAnnText::IsFontStrikeThrough.