C1.Win.C1DX.4.8 Assembly / C1.Util.DX.DirectWrite Namespace / TextRenderer Interface / DrawStrikethrough Method
The application-defined drawing context passed to IDWriteTextLayout::Draw.
The pixel location (X-coordinate) at the baseline origin of the run where strikethrough applies.
The pixel location (Y-coordinate) at the baseline origin of the run where strikethrough applies.
Pointer to a structure containing strikethrough logical information.
Application-defined effect to apply to the strikethrough. Usually this argument represents effects such as the foreground brush filling the interior of a line.

In This Topic
DrawStrikethrough Method (TextRenderer)
In This Topic
IDWriteTextLayout::Draw calls this function to instruct the client to draw a strikethrough.
Syntax
'Declaration
 
Function DrawStrikethrough( _
   ByVal clientDrawingContext As System.Object, _
   ByVal baselineOriginX As System.Single, _
   ByVal baselineOriginY As System.Single, _
   ByRef strikethrough As Strikethrough, _
   ByVal clientDrawingEffectPtr As System.IntPtr _
) As HResult
 

Parameters

clientDrawingContext
The application-defined drawing context passed to IDWriteTextLayout::Draw.
baselineOriginX
The pixel location (X-coordinate) at the baseline origin of the run where strikethrough applies.
baselineOriginY
The pixel location (Y-coordinate) at the baseline origin of the run where strikethrough applies.
strikethrough
Pointer to a structure containing strikethrough logical information.
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.

Return Value

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.
See Also