The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IDWriteTextFormat::SetLineSpacing method

Sets the line spacing.

Syntax

C++


virtual HRESULT SetLineSpacing(
   DWRITE_LINE_SPACING_METHOD  lineSpacingMethod,
   FLOAT                       lineSpacing,
   FLOAT                       baseline
) = 0;

Parameters

lineSpacingMethod

Type: DWRITE_LINE_SPACING_METHOD

Specifies how line height is being determined; see DWRITE_LINE_SPACING_METHOD for more information.

lineSpacing

Type: FLOAT

The line height, or distance between one baseline to another.

baseline

Type: FLOAT

The distance from top of line to baseline. A reasonable ratio to lineSpacing is 80 percent.

Return value

Type: HRESULT

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

Remarks

For the default method, spacing depends solely on the content. For uniform spacing, the specified line height overrides the content.

Requirements

Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| Windows Store apps]
Minimum supported phone	Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]
Header	Dwrite.h
Library	Dwrite.lib
DLL	Dwrite.dll