iText.Kernel.Pdf.Tagging.PdfStructIdTree Class Reference
Models the tree of structure element IDs. More...
Inheritance diagram for iText.Kernel.Pdf.Tagging.PdfStructIdTree:
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... |
|
| override void | AddEntry (PdfString key, PdfObject value) |
| Add an entry to the name tree. More... |
|
 Public Member Functions inherited from iText.Kernel.Pdf.GenericNameTree |
|
| 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... |
|
Additional Inherited Members |
|
| Package Functions inherited from iText.Kernel.Pdf.GenericNameTree |
|
| GenericNameTree (PdfDocument pdfDoc) | |
| Creates a name tree structure in the current document. More... |
|
| virtual void | AddEntry (PdfString key, PdfObject value, Action< PdfDocument > onErrorAction) |
| Add an entry to the name tree. More... |
|
| void | SetItems (LinkedDictionary< PdfString, PdfObject > items) |
| LinkedDictionary< PdfString, PdfObject > | GetItems () |
| Static Package Functions inherited from iText.Kernel.Pdf.GenericNameTree |
|
| static LinkedDictionary< PdfString, PdfObject > | ReadTree (PdfDictionary dictionary) |
| Read the entries in a name tree structure from a dictionary object into a linked hash map with fixed order. 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
◆ AddEntry()
|
inlinevirtual |
Add an entry to the name tree.
- Parameters
-
key key of the entry value object to add
Reimplemented from iText.Kernel.Pdf.GenericNameTree.
◆ GetStructElemById() [1/2]
|
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]
|
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.
