PdfStructureElement Class

Namespace: Meziantou.Framework.Pdf
Assembly: Meziantou.Framework.Pdf.dll
Package: Meziantou.Framework.Pdf 1.0.7
Source: PdfStructureElement.cs
Available in package assets: net10.0net11.0

An element of the structure tree of a tagged document (ISO 32000-2, 14.7.2): a paragraph, a heading, a figure, a table... Its content is the marked content the content builder tags with it (PdfContentBuilder.BeginStructureElement), its annotations and its child elements.

public sealed class PdfStructureElement

Properties

Name	Description
ActualText	Gets or sets the replacement text (`/ActualText`): the text the content of the element shows, such as the letters of a drawn initial.
AlternateDescription	Gets or sets the alternate description (`/Alt`): the text that replaces a figure or a formula for the readers that cannot show it.
Children	Gets the child elements.
Dictionary	Gets the dictionary of the element.
Expansion	Gets or sets the expansion of an abbreviation or an acronym (`/E`).
Language	Gets or sets the language of the content of the element (`/Lang`), a BCP 47 tag such as `en-US`, when it is not the language of the document.
Title	Gets or sets the title of the element (`/T`).
Type	Gets the structure type (`/S`): a standard type such as `P`, `H1` or `Figure`, or a type of the role map.

ActualText

PdfStructureElement.cs

Gets or sets the replacement text (/ActualText): the text the content of the element shows, such as the letters of a drawn initial.

public string? ActualText { get; set; }

Property value

string?

AlternateDescription

PdfStructureElement.cs

Gets or sets the alternate description (/Alt): the text that replaces a figure or a formula for the readers that cannot show it.

public string? AlternateDescription { get; set; }

Property value

string?

Children

PdfStructureElement.cs

Gets the child elements.

public IReadOnlyList<PdfStructureElement> Children { get; }

Property value

IReadOnlyList<PdfStructureElement>

Dictionary

PdfStructureElement.cs

Gets the dictionary of the element.

public PdfDictionary Dictionary { get; }

Property value

PdfDictionary

Expansion

PdfStructureElement.cs

Gets or sets the expansion of an abbreviation or an acronym (/E).

public string? Expansion { get; set; }

Property value

string?

Language

PdfStructureElement.cs

Gets or sets the language of the content of the element (/Lang), a BCP 47 tag such as en-US, when it is not the language of the document.

public string? Language { get; set; }

Property value

string?

Title

PdfStructureElement.cs

Gets or sets the title of the element (/T).

public string? Title { get; set; }

Property value

string?

Type

PdfStructureElement.cs

Gets the structure type (/S): a standard type such as P, H1 or Figure, or a type of the role map.

public string Type { get; }

Property value

string

Methods

Name	Description
AddAnnotation(PdfAnnotation)	Adds an annotation of a page to the content of the element (an object reference, 14.7.5.3): a link of the text of the element, for instance.
AddElement(string)	Adds a child element.

AddAnnotation(PdfAnnotation)

PdfStructureElement.cs

Adds an annotation of a page to the content of the element (an object reference, 14.7.5.3): a link of the text of the element, for instance.

public void AddAnnotation(PdfAnnotation annotation)

Parameters

annotation PdfAnnotation: The annotation.

Exceptions

ArgumentException: The annotation is not on a page of the document.

AddElement(string)

PdfStructureElement.cs

Adds a child element.

public PdfStructureElement AddElement(string type)

Parameters

type string: The structure type: a standard type such as P, H1, Figure or Table, or a type of PdfStructureTree.RoleMap.

Returns

PdfStructureElement The element.