dotnet-framework-api
- C1.Win.Bitmap.4.8 Assembly
- C1.Win.C1DX.4.8 Assembly

C1.Util.DX.DirectWrite.TextRenderer.DrawStrikethrough

DrawStrikethrough Method

DrawStrikethrough(object, float, float, ref Strikethrough, IntPtr)

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

Declaration

HResult DrawStrikethrough(object clientDrawingContext, float baselineOriginX, float baselineOriginY, ref Strikethrough strikethrough, IntPtr clientDrawingEffectPtr)

Parameters

Type	Name	Description
object	clientDrawingContext	The application-defined drawing context passed to IDWriteTextLayout::Draw.
float	baselineOriginX	The pixel location (X-coordinate) at the baseline origin of the run where strikethrough applies.
float	baselineOriginY	The pixel location (Y-coordinate) at the baseline origin of the run where strikethrough applies.
Strikethrough	strikethrough	Pointer to a structure containing strikethrough logical information.
IntPtr	clientDrawingEffectPtr	Application-defined effect to apply to the strikethrough. Usually this argument represents effects such as the foreground brush filling the interior of a line.

Returns

Type	Description
HResult	If the 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.