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.v19.1.Core.dll

Declaration

C#

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

VB.NET

<DefaultValue(PdfBookmarkDisplayMode.None)>
<XtraSerializableProperty>
Public Overridable Property DisplayBookmarksInPdfNavigationPane As PdfBookmarkDisplayMode

Property Value

Type	Default	Description
PdfBookmarkDisplayMode	**None**	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:

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.

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.

Related GitHub Examples

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.

C#

displaying-bookmark-names-in-the-bookmarks-pane-of-pdf-viewer-for-a-document-exported-to-p-t420469/CS/BookmarkTitleUpdater/Form1.cs#L21

// should be displayed in the Bookmarks panel of PDF Viewer after the document is exported to PDF.
richEditControl.Options.Bookmarks.DisplayBookmarksInPdfNavigationPane = PdfBookmarkDisplayMode.All;

VB.NET

displaying-bookmark-names-in-the-bookmarks-pane-of-pdf-viewer-for-a-document-exported-to-p-t420469/VB/BookmarkTitleUpdater/Form1.vb#L20

' should be displayed in the Bookmarks panel of PDF Viewer after the document is exported to PDF.
richEditControl.Options.Bookmarks.DisplayBookmarksInPdfNavigationPane = PdfBookmarkDisplayMode.All