Skip to main content
.NET Framework 4.5.2+

BookmarkOptions.DisplayBookmarksInPdfNavigationPane Property

Specifies what bookmarks to display in the PDF viewer’s Bookmarks pane when a document is exported to PDF.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v22.1.Core.dll

Declaration

[DefaultValue(PdfBookmarkDisplayMode.None)]
[XtraSerializableProperty]
public virtual PdfBookmarkDisplayMode DisplayBookmarksInPdfNavigationPane { get; set; }

Property Value

Type Default Description
PdfBookmarkDisplayMode

None

A PdfBookmarkDisplayMode enumeration member that specifies what bookmarks should appear in the Bookmarks pane.

Property Paths

You can access this nested property as listed below:

Library Object Type Path to DisplayBookmarksInPdfNavigationPane
WinForms Controls SnapControlOptions
.Bookmarks.DisplayBookmarksInPdfNavigationPane
RichEditControlOptions
.Bookmarks.DisplayBookmarksInPdfNavigationPane
WPF Controls RichEditControlOptions
.Bookmarks.DisplayBookmarksInPdfNavigationPane
Office File API RichEditControlOptionsBase
.Bookmarks.DisplayBookmarksInPdfNavigationPane
ASP.NET Web Forms Controls ASPxRichEditSettings
.Bookmarks.DisplayBookmarksInPdfNavigationPane

Remarks

The DisplayBookmarksInPdfNavigationPane property allows you to display a Table of Contents or hyperlinks to document bookmarks in the Bookmarks navigation pane of the PDF viewer, as illustrated in the following image.

BookmarksNavigationPane_PDF

Set the DisplayBookmarksInPdfNavigationPane property to the PdfBookmarkDisplayMode.TocBookmarks value to show only bookmarks generated with the TOC field.

Use the DisplayUnreferencedPdfBookmarks property to determine whether to show bookmarks without references (i.e., without hyperlinks anchored to these bookmarks) in the Bookmarks navigation pane. The DisplayBookmarksInPdfNavigationPane property set PdfBookmarkDisplayMode.None controls the unreferenced bookmarks when the DisplayUnreferencedPdfBookmarks property is set to true.

The Bookmarks navigation pane displays the Bookmark.Name for visible bookmarks, and the text contained in the Bookmark.Range for hidden bookmarks.

The displayed text’s length is limited to 512 symbols.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DisplayBookmarksInPdfNavigationPane property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also