pdfGetWrappedTextBreakString
Same as [pdfGetWrappedText](#api-pdfgetwrappedtext), but a
| Category | Text measurement |
|---|
Purpose — Same as pdfGetWrappedText, but a single word wider than Width is hard-broken character by character instead of overflowing the line.
Description — At each hard-break point, the configured break marker (set via pdfSetBreakString; empty by default) is appended to the truncated line before the delimiter.
Declarations
const char* __stdcall pdfGetWrappedTextBreakString(PPDF IPDF, double Width, const char* Delimiter, const char* Text);
const char* __stdcall pdfGetWrappedTextBreakStringA(PPDF IPDF, double Width, const char* Delimiter, const char* Text);
const wchar_t* __stdcall pdfGetWrappedTextBreakStringW(PPDF IPDF, double Width, const wchar_t* Delimiter, const wchar_t* Text);
function pdfGetWrappedTextBreakStringA(const IPDF: PPDF; Width: Double; Delimiter, Text: PAnsiChar): PAnsiChar; stdcall; external 'LumasPdf.dll';
function pdfGetWrappedTextBreakStringW(const IPDF: PPDF; Width: Double; Delimiter, Text: PWideChar): PWideChar; stdcall; external 'LumasPdf.dll';
Parameters
| Parameter | Type | Description |
|---|---|---|
IPDF | PPDF | Instance handle. |
Width | Double | Wrap width. |
Delimiter | string | Line joiner. |
Text | string | Source text. |
Return value — The wrapped, hard-broken, Delimiter-joined string.
See also — pdfGetWrappedText, pdfSetBreakString
C# (P/Invoke)
public static extern IntPtr pdfGetWrappedTextBreakStringW(IntPtr IPDF, double Width, IntPtr Delimiter, IntPtr Text);
public static extern IntPtr pdfGetWrappedTextBreakString(IntPtr IPDF, double Width, IntPtr Delimiter, IntPtr Text);
public static extern IntPtr pdfGetWrappedTextBreakStringA(IntPtr IPDF, double Width, IntPtr Delimiter, IntPtr Text);
Getters
pdfGetWrappedTextBreakStringW
pdfGetWrappedTextBreakString
pdfGetWrappedTextBreakStringA
The …A form takes UTF-8, …W
takes UTF-16; a bare name aliases the ANSI form.
Worked examples — complete programs in ten languages.