PdfOutlineItem Class

Definition

One item (bookmark) of the document outline: its title, where it leads, how it looks, and its children.

public sealed class PdfOutlineItem

Remarks

ISO 32000-2 §12.3.3, Tables 151 and 152. The properties read the item dictionary on every call and return the defaults the clause gives (black, no flags) without writing them. Children, Parent and Level read the shape of the outline the catalog names as its links are now: an edit through any view, or straight to the COS objects, shows at the next read. The outline is walked again only when a dictionary the last walk read has changed (see PdfOutline); an item stays the same view while it stays in the outline. An item the outline does not reach (removed, or of an outline the catalog no longer names) has no parent, no children and level 0.

The setters and Add(String), Insert(Int32, String), MoveTo(PdfOutlineItem?, Int32) and Remove() edit the outline in place (§12.3.3, Tables 150 and 151): they work on the links as they are now, not on an earlier walk, keep First, Last, Prev, Next and Parent consistent around the change, and correct the Count of every ancestor whose visible descendants change. They are mutations: no read may run concurrently with them.

An item may have both Dest and A, which the clause forbids; both are exposed, and a reader that activates the item should prefer Action (as viewers do). A Dest holding an action dictionary reads as Action.

Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Properties (15)

Methods (4)