Bookmarks
- 2 minutes to read
This document introduces PDF Viewer bookmarks, and describes their capabilities and customization options on a navigation pane.
This document consists of the following sections.
Overview
Bookmarks (outlines) are used to navigate quickly from one part of a document to another. The PDF Viewer can show bookmarks on the navigation pane for a PDF document that contains them.
When you click on a bookmark, the PDF Viewer displays a page linked to the bookmark (see the image below). Bookmarks can also open web pages.
Bookmarks can be displayed in a hierarchical tree providing a convenient document overview. They can show or hide the document hierarchy in the navigation pane. To open (or close) the bookmark items, click them with the mouse.
After the bookmark item is open, you can see its children in the pane.
Customization
This section describes properties that can be used to customize bookmarks of a PDF Viewer and explains how they can be accessed both at design time and runtime.
To customize bookmark behavior on the navigation pane, access a PdfOutlineViewerSettings object using the PdfViewer.OutlineViewerSettings property.
The outline viewer settings are detailed in the following table.
| Member | Description |
|---|---|
| PdfOutlineViewerSettings.HideAfterUse | Gets or sets a value which specifies whether the PDF outline pane is hidden after clicking on the outline item. |
| PdfOutlineViewerSettings.WrapLongLines | Gets or sets a value which defines whether to wrap long lines in the outline node text of the PDF outline viewer. |
| PdfOutlineViewerSettings.UseOutlinesForeColor | Specifies whether to use document foreground colors for the outline node text in the navigation pane. |
| PdfOutlineViewerSettings.TextSize | Gets or sets the text size of nodes located in the PDF outline viewer (navigation pane). |
Bookmark settings are also accessible at runtime. To do this, click the Options drop-down button in the Bookmarks panel, as shown below.
You can also customize the navigation pane where the Bookmarks tab is located. For more information, refer to the Navigation Pane document.