ASPxRichEditBookmarkSettings.DisplayBookmarksInPdfNavigationPane Property

Gets or sets a value specifying the mode for displaying bookmarks in the Bookmarks pane of PDF viewer when a document is exported to PDF.

Namespace: DevExpress.Web.ASPxRichEdit

Assembly: DevExpress.Web.ASPxRichEdit.v23.2.dll

NuGet Package: DevExpress.Web.Office

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
PdfBookmarkDisplayMode	None	One of the PdfBookmarkDisplayMode values.

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
ASPxRichEditSettings	.Bookmarks .DisplayBookmarksInPdfNavigationPane

Remarks

The DisplayBookmarksInPdfNavigationPane property allows you to display hyperlinks in document bookmarks in the Bookmarks navigation pane of the PDF viewer.

The Bookmarks navigation pane does not display the Bookmark.name, but the text contained in the bookmarked range.