Windows apps
Collapse the table of content
Expand the table of content
Information
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.

IDWriteTextRenderer::DrawStrikethrough method

IDWriteTextLayout::Draw calls this function to instruct the client to draw a strikethrough.

Syntax


virtual HRESULT DrawStrikethrough(
             void                 * clientDrawingContext,
             FLOAT                 baselineOriginX,
             FLOAT                 baselineOriginY,
  [inconst DWRITE_STRIKETHROUGH * strikethrough,
             IUnknown             * clientDrawingEffect
) = 0;

Parameters

clientDrawingContext

Type: void*

The application-defined drawing context passed to IDWriteTextLayout::Draw.

baselineOriginX

Type: FLOAT

The pixel location (X-coordinate) at the baseline origin of the run where strikethrough applies.

baselineOriginY

Type: FLOAT

The pixel location (Y-coordinate) at the baseline origin of the run where strikethrough applies.

strikethrough [in]

Type: const DWRITE_STRIKETHROUGH*

Pointer to a structure containing strikethrough logical information.

clientDrawingEffect

Type: IUnknown*

Application-defined effect to apply to the strikethrough. Usually this argument represents effects such as the foreground brush filling the interior of a line.

Return value

Type: HRESULT

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

Remarks

A single strikethrough can be broken into multiple calls, depending on how the formatting changes attributes. Strikethrough is not averaged across font sizes/styles changes. To get an appropriate starting pixel position, add strikethrough::offset to the baseline. Like underlines, the x coordinate will always be passed as the left side, regardless of text directionality.

Requirements

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]

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

See also

IDWriteTextRenderer

 

 

Show:
© 2017 Microsoft