IDWriteTextFormat::GetLineSpacing method
Gets the line spacing adjustment set for a multiline text paragraph.
Syntax
virtual HRESULT GetLineSpacing(
[out] DWRITE_LINE_SPACING_METHOD * lineSpacingMethod,
[out] FLOAT * lineSpacing,
[out] FLOAT * baseline
) = 0;
Parameters
- lineSpacingMethod [out]
-
Type: DWRITE_LINE_SPACING_METHOD*
A value that indicates how line height is determined.
- lineSpacing [out]
-
Type: FLOAT*
When this method returns, contains the line height, or distance between one baseline to another.
- baseline [out]
-
Type: FLOAT*
When this method returns, contains 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.
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 |
|
|
Library |
|
|
DLL |
|
See also