Class StructureElement

A single tagged structure element node (/StructElem).

Inheritance
object
StructureElement
Inherited Members
Namespace: DRIT.Pdf.Tagged
Assembly: DRIT.Pdf.dll
Syntax
public sealed class StructureElement

Properties

AlternateText

Optional alternate text, typically used for figures/images.

Declaration
public string? AlternateText { get; set; }
Property Value
Type Description
string

Children

Child structure elements.

Declaration
public IReadOnlyList<StructureElement> Children { get; }
Property Value
Type Description
IReadOnlyList<StructureElement>

Count

Number of direct child elements.

Declaration
public int Count { get; }
Property Value
Type Description
int

this[int]

Gets child structure element by zero-based index.

Declaration
public StructureElement this[int index] { get; }
Parameters
Type Name Description
int index
Property Value
Type Description
StructureElement

MarkedContentId

Optional MCID used when linking the node to marked content.

Declaration
public int? MarkedContentId { get; }
Property Value
Type Description
int?

MarkedPage

Optional page reference used with MCID linkage.

Declaration
public Page? MarkedPage { get; }
Property Value
Type Description
Page

StructureType

Structure role/type (for example P, Span, Link, Table, TR, TD, Note).

Declaration
public string StructureType { get; set; }
Property Value
Type Description
string

Title

Optional title/name of this structure node.

Declaration
public string? Title { get; set; }
Property Value
Type Description
string

Methods

AddChild(string)

Add a child structure element.

Declaration
public StructureElement AddChild(string structureType)
Parameters
Type Name Description
string structureType
Returns
Type Description
StructureElement

SetMarkedContent(Page, int)

Associate this element with a marked content identifier on a page.

Declaration
public void SetMarkedContent(Page page, int markedContentId)
Parameters
Type Name Description
Page page
int markedContentId