iText 8.0.2 API
iText.Kernel.Pdf.Tagging.PdfStructIdTree Class Reference

Models the tree of structure element IDs. More...

Inheritance diagram for iText.Kernel.Pdf.Tagging.PdfStructIdTree:
iText.Kernel.Pdf.GenericNameTree iText.Kernel.Pdf.IPdfNameTreeAccess

Public Member Functions

virtual PdfStructElem  GetStructElemById (PdfString id)
  Retrieve a structure element by ID, if it has one. More...
 
virtual PdfStructElem  GetStructElemById (byte[] id)
  Retrieve a structure element by ID, if it has one. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.GenericNameTree
virtual void  AddEntry (PdfString key, PdfObject value)
  Add an entry to the name tree. More...
 
virtual void  AddEntry (String key, PdfObject value)
  Add an entry to the name tree. More...
 
virtual void  RemoveEntry (PdfString key)
  Remove an entry from the name tree. More...
 
virtual PdfObject  GetEntry (PdfString key)
  Retrieve an entry from the name tree. More...
 
virtual PdfObject  GetEntry (String key)
  Retrieve an entry from the name tree. More...
 
virtual ICollection< PdfString GetKeys ()
  Retrieve the set of keys in the name tree. More...
 
virtual bool  IsModified ()
  Check if the tree is modified. More...
 
virtual void  SetModified ()
  Sets the modified flag to true. More...
 
virtual PdfDictionary  BuildTree ()
  Build a PdfDictionary containing the name tree. More...
 

Detailed Description

Models the tree of structure element IDs.

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

Member Function Documentation

◆ GetStructElemById() [1/2]

virtual PdfStructElem iText.Kernel.Pdf.Tagging.PdfStructIdTree.GetStructElemById ( byte[]  id )
inlinevirtual

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

Parameters
id the ID of the structure element to retrieve
Returns
the structure element with the given ID if one exists, or null otherwise.

◆ GetStructElemById() [2/2]

virtual PdfStructElem iText.Kernel.Pdf.Tagging.PdfStructIdTree.GetStructElemById ( PdfString  id )
inlinevirtual

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

Parameters
id the ID of the structure element to retrieve
Returns
the structure element with the given ID if one exists, or null otherwise.