StructureElementElement Class    

This class represents the structure element dictionary. This is definitively detailed in:.

The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558.

The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721.

This class is always an indirect object because OutlineItemElement.EntrySE, StructureElementElement.EntryP and StructureElementElement.EntryRef require it to be so.

A structure element represents one node in the logical structure tree of a tagged PDF document. Structure elements form a hierarchy mirroring the logical organization of the content: sections, paragraphs, headings, tables, and figures.

The S entry names the structure type, identifying the element role. Standard types cover document-level containers, block-level elements, and inline elements. Non-standard types must be mapped to standard ones via the role map.

The K entry references the children of this element. Children may be other structure elements, marked content references, object references, integers as MCID shortcuts, or inline dictionaries combining a page reference with an MCID.

The A entry holds attribute objects describing visual and structural properties. Attributes may specify placement, spacing, borders, color, and other properties. The C entry references class names in the ClassMap to inherit shared attribute sets.

The T entry provides a human-readable title for the element. The Alt entry provides an alternate description for figures and other non-text content to support screen readers.

The Lang entry specifies the natural language of the element content, overriding ancestor declarations and allowing multilingual documents to tag each section correctly.

The ActualText entry holds the Unicode text the element content represents, used when rendered glyphs do not directly map to the intended text, such as in ligatures or glyph substitutions.

The Ref entry holds an array of references to logically related structure elements, supporting cross-references within the structure tree.

The NS entry references the namespace to which this element type belongs. When absent, the element type is in the standard PDF namespace.

The PhoneticAlphabet and Phoneme entries support text-to-speech rendering by providing a phonetic transcription of the element content using a named phonetic alphabet.

System.Object
    WebSupergoo.ABCpdf14.Elements.Element
       WebSupergoo.ABCpdf14.Elements.StructureElementElement

 

    
   
Method
Description
StructureElementElement Create a new StructureElementElement.
AddKid Adds a child StructureElementElement to this one.
InsertKid Inserts a child StructureElementElement in a particular location under this one.
GetBBox Get the bounding box for the structure element.
SetBBox Sets the bounding box for the structure element.
GetPage Get the Page object for this particular structure element.
SetPage Sets the Page for this structure element.
GetStyle Gets the text style for this structure element.
SetParent Sets the parent of this structure element.
FindMcids Finds all the MCIDs referenced by this structure element and its children.
inherited methods...

 

    
   
Property
Description
EntryType Represents the "Type" entry of the structure element dictionary object.
EntryS Represents the "S" entry of the structure element dictionary object.
EntryP Represents the "P" entry of the structure element dictionary object.
EntryID Represents the "ID" entry of the structure element dictionary object.
EntryPg Represents the "Pg" entry of the structure element dictionary object.
EntryK Represents the "K" entry of the structure element dictionary object.
EntryA Represents the "A" entry of the structure element dictionary object.
EntryC Represents the "C" entry of the structure element dictionary object.
EntryR Represents the "R" entry of the structure element dictionary object.
EntryT Represents the "T" entry of the structure element dictionary object.
EntryLang Represents the "Lang" entry of the structure element dictionary object.
EntryAlt Represents the "Alt" entry of the structure element dictionary object.
EntryE Represents the "E" entry of the structure element dictionary object.
EntryActualText Represents the "ActualText" entry of the structure element dictionary object.
EntryRef Represents the "Ref" entry of the structure element dictionary object.
EntryAF Represents the "AF" entry of the structure element dictionary object.
EntryNS Represents the "NS" entry of the structure element dictionary object.
EntryPhoneticAlphabet Represents the "PhoneticAlphabet" entry of the structure element dictionary object.
EntryPhoneme Represents the "Phoneme" entry of the structure element dictionary object.
inherited properties...