Platforms to show: All Mac Windows Linux Cross-Platform

Back to PDFOutlineMBS class.

PDFOutlineMBS.childAtIndex(index as Integer) as PDFOutlineMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS PDFKit Plugin 8.0 ✅ Yes ❌ No ❌ No ✅ Yes All
PDFOutline child at index.

Will throw exception if index is out of range.

PDFOutlineMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes All
Initializes a PDFOutline object.

If you want the PDFOutline object returned by this method to be the outline root, you must add additional PDFOutline objects to create the outline hierarchy you desire. Then, you must add the root outline object to your PDF document by assigning it to the PDFDocument OutlineRoot.

If you want the PDFOutline object returned by this method to be a child of an existing outline, you must use setLabel: to give it a label and give it either a destination or action using setDestination: or setAction:, respectively. In addition, you must add this outline object to the existing PDFOutline object as a new child, using insertChild.

Available in Mac OS X v10.4 and later.

See also:

PDFOutlineMBS.Constructor(Handle as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS PDFKit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a new object based on a given PDFOutline handle.

Please pass in a non zero handle which points to a PDFOutline object.
For use with declares.

See also:

PDFOutlineMBS.insertChild(child as PDFOutlineMBS, index as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes All
Inserts the specified outline object at the specified index.

To build a PDF outline hierarchy, use this method to add child outline objects. Before you call this method on a PDFOutline object that already has a parent, you should retain the object and call removeFromParent on it first.

Available in Mac OS X v10.5 and later.

Some examples using this method:

PDFOutlineMBS.removeFromParent

Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes All
Removes the outline object from its parent (does nothing if outline object is the root outline object).

Available in Mac OS X v10.5 and later.

The items on this page are in the following plugins: MBS PDFKit Plugin.


The biggest plugin in space...