Edit

IDWriteTextFormat::SetLineSpacing method (dwrite.h)

  • Article

Sets the line spacing.

Syntax

HRESULT SetLineSpacing(
  DWRITE_LINE_SPACING_METHOD lineSpacingMethod,
  FLOAT                      lineSpacing,
  FLOAT                      baseline
);

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

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

IDWriteTextFormat