IDWriteTextLayout::SetUnderline method (dwrite.h)

  • Article

Sets underlining for text within a specified text range.

Syntax

HRESULT SetUnderline(
  BOOL              hasUnderline,
  DWRITE_TEXT_RANGE textRange
);

Parameters

hasUnderline

Type: BOOL

A Boolean flag that indicates whether underline takes place within a specified text range.

textRange

Type: DWRITE_TEXT_RANGE

Text range to which this change applies.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteTextLayout