---
title: outlineRoot
framework: pdfkit
role: symbol
role_heading: Instance Property
path: pdfkit/pdfdocument/outlineroot
---

# outlineRoot

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

## Declaration

```swift
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

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

## See Also

### Related Documentation

- [PDFDocument](pdfkit/pdfdocument.md)

### Accessing Document Information

- [documentURL](pdfkit/pdfdocument/documenturl.md)
- [majorVersion](pdfkit/pdfdocument/majorversion.md)
- [minorVersion](pdfkit/pdfdocument/minorversion.md)
- [string](pdfkit/pdfdocument/string.md)
- [outlineItem(for:)](pdfkit/pdfdocument/outlineitem(for:).md)
- [documentAttributes](pdfkit/pdfdocument/documentattributes.md)
- [documentRef](pdfkit/pdfdocument/documentref.md)