How to add bookmarks in WinForms PDF using C# and VB.NET?
A bookmark is a type of link with representative text in the navigation panel. Each bookmark goes to a different view or page in the document. Syncfusion Essential® PDF is a .NET PDF Library used to create, read, and edit PDF documents. Using this library, you can add bookmarks with different styles in a PDF using C# and VB.NET.
Steps to add bookmarks in the PDF programmatically:
- Create a new C# console application project.
- Install the Syncfusion.Pdf.WinForms NuGet package as reference to your .NET Framework application from NuGet.org.
- Include the following namespaces in the Program.cs file.
C#
using Syncfusion.Pdf; using Syncfusion.Pdf.Graphics; using Syncfusion.Pdf.Interactive; using System.Drawing;
VB.NET
Imports Syncfusion.Pdf Imports Syncfusion.Pdf.Graphics Imports Syncfusion.Pdf.Interactive Imports System.Drawing
- Use the following code snippet to add bookmarks in PDF document.
C#
//Creates a new document
PdfDocument document = new PdfDocument();
//Adds a page
PdfPage page = document.Pages.Add();
//Creates a bookmark
PdfBookmark bookmark = document.Bookmarks.Add("Chapter 1");
//Sets the destination page
bookmark.Destination = new PdfDestination(page);
//Sets the destination location
bookmark.Destination.Location = new PointF(10, 10);
//Draw the content in the PDF page
page.Graphics.DrawString("Chapter1", new PdfStandardFont(PdfFontFamily.Helvetica, 10f), PdfBrushes.Red, new PointF(10,10));
//Adds the child bookmark
PdfBookmark childBookmark = bookmark.Insert(0, "Section 1");
childBookmark.Destination = new PdfDestination(page);
childBookmark.Destination.Location = new PointF(30, 30);
//Draw the content in the PDF page
page.Graphics.DrawString("Section1", new PdfStandardFont(PdfFontFamily.Helvetica, 10f), PdfBrushes.Green, new PointF(30, 30));
//Sets the text style and color
bookmark.TextStyle = PdfTextStyle.Bold;
bookmark.Color = Color.Red;
//Save the PDF document
document.Save("Bookmark.pdf");
//Close the PDF document
document.Close(true);
//This will open the PDF file so, the result will be seen in default PDF viewer
Process.Start("Bookmark.pdf");
VB.NET
'Creates a new document
Dim document As New PdfDocument()
'Adds a page
Dim page As PdfPage = document.Pages.Add()
'Creates bookmark
Dim bookmark As PdfBookmark = document.Bookmarks.Add("Chapter 1")
'Sets the destination page
bookmark.Destination = New PdfDestination(page)
'Sets the destination location
bookmark.Destination.Location = New PointF(10, 10)
'Draw the content in the PDF page
page.Graphics.DrawString("Chapter1", New PdfStandardFont(PdfFontFamily.Helvetica, 10.0F), PdfBrushes.Red, New PointF(10, 10))
'Adds the child bookmark
Dim childBookmark As PdfBookmark = bookmark.Insert(0, "Section 1")
childBookmark.Destination = New PdfDestination(page)
childBookmark.Destination.Location = New PointF(30, 30)
'Draw the content in the PDF page
page.Graphics.DrawString("Section1", New PdfStandardFont(PdfFontFamily.Helvetica, 10.0F), PdfBrushes.Green, New PointF(30, 30))
'Sets the text style and color
bookmark.TextStyle = PdfTextStyle.Bold
bookmark.Color = Color.Red
'Save the PDF document
document.Save("Bookmark.pdf")
'Close the PDF document
document.Close(True)
'This will open the PDF file so, the result will be seen in default PDF viewer
Process.Start("Bookmark.pdf")
A complete working sample can be downloaded from PDFBookmarkSample.zip.
By executing the program, you will get the PDF document as follows, 
Take a moment to peruse the documentation, where you can find other options like adding, Inserting, removing, and modifying bookmarks in an existing PDF document and features like named destination, interactive annotations, PDF form filling, and insert hyperlink to PDF with code examples.
Refer here to explore the rich set of Syncfusion Essential PDF features.
An online sample link to add bookmark with the different style in the PDF document.
Starting with v16.2.0.x, if you reference Syncfusion® assemblies from trial setup or from the NuGet feed, include a license key in your projects. Refer to link to learn about generating and registering Syncfusion® license key in your application to use the components without trail message.
Conclusion
I hope you enjoyed learning about how to add bookmarks in WinForms PDF using C# and VB.NET.
You can refer to our WinForms PDF feature tour page to know about its other groundbreaking feature representations and documentation, and how to quickly get started for configuration specifications. You can also explore our WinForms PDF example to understand how to create and manipulate data.
For current customers, you can check out our components from the License and Downloads page. If you are new to Syncfusion®, you can try our 30-day free trial to check out our other controls.
If you have any queries or require clarifications, please let us know in the comments section below. You can also contact us through our support forums, Direct-Trac, or feedback portal. We are always happy to assist you!
