<!--
{
  "availability" : [
    "iOS: 11.0.0 -",
    "iPadOS: 11.0.0 -",
    "macCatalyst: 13.1.0 -",
    "macOS: 10.6.0 -",
    "tvOS: 11.0.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "PDFKit",
  "identifier" : "/documentation/PDFKit/PDFDocument/outlineRoot",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "PDFKit"
    ],
    "preciseIdentifier" : "c:objc(cs)PDFDocument(py)outlineRoot"
  },
  "title" : "outlineRoot"
}
-->

# outlineRoot

The document’s root outline to a PDF outline object.

```
var outlineRoot: PDFOutline? { get set }
```

## Parameters

`outline`

The outline to be used as the document’s root outline. Pass `NULL` to strip the outline from a document.

## Discussion

When a PDF document is saved, the outline tree structure is written out to the destination PDF file.

## See Also

[`PDFDocument`](/documentation/PDFKit/PDFDocument)

An object that represents PDF data or a PDF file and defines methods for writing, searching, and selecting PDF data.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)