THPDFLayoutDiagnosticKind Type
Classifies the layout event that the streaming layout engine records in a layout diagnostic record
Declaration
THPDFLayoutDiagnosticKind= (ldkAutomaticPageBreak, ldkKeepWithNext,
ldkOrphanControl, ldkWidowControl, ldkOverflow, ldkImmediateFlush,
ldkPageLayer, ldkOverlap);Unit
HPDFDoc
Values
| Value | Meaning |
|---|---|
ldkAutomaticPageBreak | A new page was started in the normal flow, for instance because no complete line fits above the bottom margin |
ldkKeepWithNext | A page break was taken so that the paragraph's final line keeps space for the following paragraph |
ldkOrphanControl | A page break was shifted so as to preserve the configured minimum number of opening lines |
ldkWidowControl | The break point was advanced so as to preserve the configured minimum number of closing lines |
ldkOverflow | An element could not fit and overflowed its bounds, for instance when automatic page addition is switched off |
ldkImmediateFlush | Closed page content was moved to file-backed layout storage so as to bound memory use |
ldkPageLayer | A registered page-layer callback was applied whilst building a page |
ldkOverlap | A tracked element's bounds intersected the bounds of a previously tracked element |
Usage notes
- Values of this type appear in the Kind field of THPDFLayoutDiagnostic records collected through THotPDF.RecordLayoutDiagnostic and the layout diagnostics options
- Overflow and overlap entries can be visualised on the page with the diagnostic overlay drawing, which colours overflow and overlap boxes differently
- Use the kind together with the record's page index, element path and reason text to locate the layout decision that produced it