LAnnotation::SetFontStrikeThrough
#include "ltwrappr.h"
virtual L_INT LAnnotation::SetFontStrikeThrough(bFontStrikeThrough=TRUE, uFlags=0)
L_BOOL bFontStrikeThrough; |
/* flag that indicates whether to apply a strike-through */ |
L_UINT uFlags; |
/* flag that indicates which objects to process */ |
Sets the value of the strike-through property of the annotation object. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
|
bFontStrikeThrough |
Flag that indicates whether to apply a 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_NOTTHIS |
[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not. |
|
ANNFLAG_RECURSE |
[0x0008] Process objects within a container, and within any subcontainers, down to any level. |
|
ANNFLAG_NOTCONTAINER |
[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves. |
|
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. |
Comments
This property determines whether the font has a line through the middle of the text.
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
Example
For an example, refer to LAnnotation::SetNameOptions.