ITextFont::SetStrikeThrough method (tom.h)

Sets whether characters are displayed with a horizontal line through the center.

Syntax

HRESULT SetStrikeThrough(
  [in] long Value
);

Parameters

[in] Value

Type: long

A tomBool value that can be one of the following.

Value Meaning
tomTrue Characters have a horizontal line through the center.
tomFalse Characters do not have a horizontal line through the center.
tomToggle Toggle the state of the StrikeThrough property.
tomUndefined The StrikeThrough property is undefined.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return code Description
E_INVALIDARG
Invalid argument.
CO_E_RELEASED
The font object is attached to a range that has been deleted.
E_ACCESSDENIED
Write access is denied.
E_OUTOFMEMORY
Insufficient memory.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

Conceptual

GetStrikeThrough

ITextFont

Reference

Text Object Model