Skip to main content

DXRichEditBookmarkOptions.DisplayBookmarksInPdfNavigationPane Property

Specifies the mode for displaying bookmarks in the Bookmarks pane of a PDF viewer when a document is exported to PDF. This is a dependency property.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.2.dll

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

public PdfBookmarkDisplayMode DisplayBookmarksInPdfNavigationPane { get; set; }

Property Value

Type Description
PdfBookmarkDisplayMode

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

Available values:

Name Description
None

Specifies that bookmarks contained in a document should not be displayed in the Bookmarks panel.

All

Specifies that all bookmarks with references in a document should be displayed in the Bookmarks panel.

TocBookmarks

Specifies that only bookmarks based on which a TOC is generated should be displayed in the Bookmarks panel.

Property Paths

You can access this nested property as listed below:

Object Type Path to DisplayBookmarksInPdfNavigationPane
RichEditControl
.BookmarkOptions .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

To show only bookmarks used in the Table of Contents generated with the TOC field, set the DisplayBookmarksInPdfNavigationPane property to the PdfBookmarkDisplayMode.TocBookmarks value.

The Bookmarks navigation pane does not display the Bookmark.Name, but the text contained in the bookmarked Bookmark.Range. The length of the displayed text is limited to 512 symbols.

See Also