Class PdfStructIdTree

Namespace

iText.Kernel.Pdf.Tagging

Assembly

itext.kernel.dll

Models the tree of structure element IDs.

public class PdfStructIdTree : GenericNameTree, IPdfNameTreeAccess

Inheritance

object

GenericNameTree

PdfStructIdTree

Implements

IPdfNameTreeAccess

Inherited Members

GenericNameTree.AddEntry(string, PdfObject)

GenericNameTree.RemoveEntry(PdfString)

GenericNameTree.GetEntry(PdfString)

GenericNameTree.GetEntry(string)

GenericNameTree.GetKeys()

GenericNameTree.IsModified()

GenericNameTree.SetModified()

GenericNameTree.BuildTree()

GenericNameTree.AddEntry(PdfString, PdfObject, Action<PdfDocument>)

GenericNameTree.SetItems(LinkedDictionary<PdfString, PdfObject>)

GenericNameTree.GetItems()

GenericNameTree.ReadTree(PdfDictionary)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Models the tree of structure element IDs. This is an optional feature of tagged PDF documents.

Methods

AddEntry(PdfString, PdfObject)

public override void AddEntry(PdfString key, PdfObject value)

Parameters

key PdfString

value PdfObject

GetStructElemById(byte[])

Retrieve a structure element by ID, if it has one.

public virtual PdfStructElem GetStructElemById(byte[] id)

Parameters

id byte[]

the ID of the structure element to retrieve

Returns

PdfStructElem

the structure element with the given ID if one exists, or null otherwise.

GetStructElemById(PdfString)

Retrieve a structure element by ID, if it has one.

public virtual PdfStructElem GetStructElemById(PdfString id)

Parameters

id PdfString

the ID of the structure element to retrieve

Returns

PdfStructElem

the structure element with the given ID if one exists, or null otherwise.