IDWriteTextLayout::SetUnderline method (Windows)

Switch View :
Classic
Lightweight
ScriptFree
IDWriteTextLayout::SetUnderline method

Applies to: desktop apps | Metro style apps

Sets underlining for text within a specified text range.

Syntax

virtual HRESULT SetUnderline(
  BOOL  hasUnderline,
  DWRITE_TEXT_RANGE  textRange
) = 0;

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

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008

Header
Dwrite.h

Library
Dwrite.lib

DLL
Dwrite.dll

See also

IDWriteTextLayout

 

 

Send comments about this topic to Microsoft

Build date: 3/7/2012