Platforms to show: All Mac Windows Linux Cross-Platform

Back to PDFOutlineMBS class.

PDFOutlineMBS.action as PDFActionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes All
The action performed when users click the outline.

The root outline serves only as a container for the outlines it owns; it does not have an action. Note that a PDFOutline object can have either an action or a destination, not both.

If the PDFOutline object has a destination, instead of an action, action returns a PDFActionGoTo object (this is equivalent to calling destination on the PDFOutline object). For other action types, action returns the appropriate PDF Kit action type object, such as PDFActionURL.

Available in Mac OS X v10.5 and later.
(Read and Write property)

PDFOutlineMBS.destination as PDFDestinationMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 8.0 ✅ Yes ❌ No ❌ No ✅ Yes All
The destination asscoiated with the outline item.

The root PDFOutline has no destination.
(Read and Write property)

PDFOutlineMBS.document as PDFDocumentMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 8.0 ✅ Yes ❌ No ❌ No ✅ Yes All
The PDFDocument the outline is asscoiated with.

(Read only property)

PDFOutlineMBS.index as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the index of the outline.

The index of the outline object is relative to its siblings and from the perspective of the parent of the outline object. The root outline object, and any outline object without a parent, has an index value of 0.

Available in Mac OS X v10.5 and later.
(Read only property)

PDFOutlineMBS.isOpen as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes All
Whether the outline object is initially disclosed.

Calling isOpen on an outline object that has no children always returns false. Calling isOpen on the root outline object always returns true.

Available in Mac OS X v10.5 and later.
(Read and Write property)

PDFOutlineMBS.label as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 8.0 ✅ Yes ❌ No ❌ No ✅ Yes All
The label for the outline.

The root PDFOutline has no label and is only a container for children PDFOutlines.
(Read and Write property)

PDFOutlineMBS.numberOfChildren as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 8.0 ✅ Yes ❌ No ❌ No ✅ Yes All
Number of PDFOutline children this PDFOutline has.

(Read only property)

PDFOutlineMBS.parent as PDFOutlineMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes All
The parent outline object of the outline.

Can be nil for the root object.
Available in Mac OS X v10.5 and later.
(Read only property)

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


The biggest plugin in space...