PdfStructureElement

6 Feb 20261 minute to read

Represents the structure element of the PDF document.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Initialize a new instance of the `PdfDataExtractor` class
let extractor: PdfDataExtractor = new PdfDataExtractor(document);
// Access the structure element of the PDF document
let rootStructureElement: PdfStructureElement = extractor.getStructureElement();
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Properties

Get abbreviation string

Gets the abbreviation (Read only).

Get actualText string

Gets the actual text of the structure element (Read only).

Get alternateText string

Gets the alternate text of the tag (Read only).

Get bounds Rectangle

Gets the bounds of the structure element (Read only).

Get childElements PdfStructureElement[]

Gets the child elements of this structure element (Read only).

Get language string

Gets the language of the structure element (Read only).

Get order number

Gets the order of the structure element (Read only).

Get page PdfPage

Gets the page associated with the structure element (Read only).

Get parent PdfStructureElement

Gets the parent element (Read only).

Get scope ScopeType

Gets the scope type of the structure element (Read only).

Get tagType PdfTagType

Gets the tag type of the structure element (Read only).

Get text string

Gets the text of the tag (Read only).

Get title string

Gets the title of the structure element (Read only).