IDWriteTextLayout::GetOverhangMetrics method (dwrite.h)

Returns the overhangs (in DIPs) of the layout and all objects contained in it, including text glyphs and inline objects.

Syntax

HRESULT GetOverhangMetrics(
  [out] DWRITE_OVERHANG_METRICS *overhangs
);

Parameters

[out] overhangs

Type: DWRITE_OVERHANG_METRICS*

Overshoots of visible extents (in DIPs) outside the layout.

Return value

Type: HRESULT

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

Remarks

Underlines and strikethroughs do not contribute to the black box determination, since these are actually drawn by the renderer, which is allowed to draw them in any variety of styles.

Requirements

Requirement Value
Target Platform Windows
Header dwrite.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteTextLayout