PdfViewer.GoToBookmark(PdfViewerBookmark) Method

Navigates to the specified bookmark.

Namespace : DevExpress.XtraPdfViewer

Assembly : DevExpress.XtraPdfViewer.v25.2.dll

NuGet Package : DevExpress.Win.PdfViewer

Declaration

C#
VB.NET

csharp

public void GoToBookmark(
    PdfViewerBookmark bookmark
)

Public Sub GoToBookmark(
    bookmark As PdfViewerBookmark
)

Parameters

Name	Type	Description
bookmark	PdfViewerBookmark

A bookmark to which the PDF Viewer should navigate.

Remarks

Use the Bookmarks property to obtain a list of document bookmarks.

The FindBookmark method allows you to find a bookmark that meets specified criteria. This method can be useful if you need to find a bookmark in a document with a complex bookmark tree.

The code sample below finds a bookmark with the specified title and navigates to this bookmark when the document is loaded:

C#
VB.NET

csharp

using DevExpress.Pdf;
using DevExpress.XtraPdfViewer;
//...
pdfViewer.DocumentChanged += pdfViewer_DocumentChanged;

private void pdfViewer_DocumentChanged(object sender, PdfDocumentChangedEventArgs e) {
    var bookmark = pdfViewer.Bookmarks.FindBookmark(x => x.Title == "4 Notation");
    if (bookmark != null) { 
        pdfViewer.GoToBookmark(bookmark); 
    }
}

Imports DevExpress.Pdf
Imports DevExpress.XtraPdfViewer
'...
Private pdfViewer.DocumentChanged += AddressOf pdfViewer_DocumentChanged

Private Sub pdfViewer_DocumentChanged(ByVal sender As Object, ByVal e As PdfDocumentChangedEventArgs)
    Dim bookmark = pdfViewer.Bookmarks.FindBookmark(Function(x) x.Title = "4 Notation")
    If bookmark IsNot Nothing Then
        pdfViewer.GoToBookmark(bookmark)
    End If
End Sub

Example

The code sample below navigates to a bookmark node with a specific title when the document is loaded:

C#
VB.NET

csharp

using DevExpress.Pdf;
using DevExpress.XtraPdfViewer;
using System.Collections.Generic;
//...
pdfViewer.DocumentChanged += pdfViewer_DocumentChanged;

// Navigate to the "Annotations" bookmark
private void pdfViewer_DocumentChanged(object sender, PdfDocumentChangedEventArgs e) {
    foreach (var bookmarkItem in pdfViewer.Bookmarks) {
        if (bookmarkItem.Title == "Annotations") 
            pdfViewer.GoToBookmark(bookmarkItem);
    }
}

Imports DevExpress.Pdf
Imports DevExpress.XtraPdfViewer
Imports System.Collections.Generic
'...
Private pdfViewer.DocumentChanged += AddressOf pdfViewer_DocumentChanged

' Navigate to the "Annotations" bookmark
Private Sub pdfViewer_DocumentChanged(ByVal sender As Object, ByVal e As PdfDocumentChangedEventArgs)
    For Each bookmarkItem In pdfViewer.Bookmarks
        If bookmarkItem.Title = "Annotations" Then
            pdfViewer.GoToBookmark(bookmarkItem)
        End If
    Next bookmarkItem
End Sub