THPDFLayoutDiagnosticKind Type
Classifies the layout event recorded by the streaming layout engine 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 example because no complete line fits above the bottom margin |
ldkKeepWithNext | A page break was taken so the paragraph's final line keeps space for the following paragraph |
ldkOrphanControl | A page break was moved to preserve the configured minimum number of opening lines |
ldkWidowControl | The break point was advanced 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 disabled |
ldkImmediateFlush | Closed page content was moved to file-backed layout storage to bound memory use |
ldkPageLayer | A registered page-layer callback was applied while 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 visualized on the page with the diagnostic overlay drawing, which colors 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