`pdfSetTextUnderlineDash`

Set a simple on/off dash pattern for the underline stroke.

Category	Text decoration

Purpose — Set a simple on/off dash pattern for the underline stroke.

Description — Equivalent to a PDF dash array [DashOn DashOff]. Clears any custom dash pattern previously set via pdfSetTextUnderlineCustomDash (mutual exclusion, same as that call's note).

Declarations

int32_t __stdcall pdfSetTextUnderlineDash(PPDF IPDF, double DashOn, double DashOff);

Delphi

function pdfSetTextUnderlineDash(const IPDF: PPDF; DashOn, DashOff: Double): Integer; stdcall; external 'LumasPdf.dll';

Parameters

Parameter	Type	Description
`IPDF`	`PPDF`	Instance handle.
`DashOn`, `DashOff`	`Double`	Dash-on and dash-off lengths in points. `0`/`0` (the default) means solid.

Return value — 1 on a valid handle; 0 on an invalid handle.

See also — pdfSetTextUnderlineCustomDash

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs

public static extern int pdfSetTextUnderlineDash(IntPtr IPDF, double DashOn, double DashOff);

Area

Text