Edit

ITextFont::SetUnderline method (tom.h)

  • Article

Sets thevtype of underlining for the characters in a range.

Syntax

HRESULT SetUnderline(
  [in] long Value
);

Parameters

[in] Value

Type: long

The type of underlining. It can be one of the following values.

tomNone

tomSingle

tomWords

tomDouble

tomDotted

tomDash

tomDashDot

tomDashDotDot

tomWave

tomThick

tomHair

tomDoubleWave

tomHeavyWave

tomLongDash

tomThickDash

tomThickDashDot

tomThickDashDotDot

tomThickDotted

tomThickLongDash

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

GetUnderline

ITextFont

Reference

Text Object Model