Blog

Add Bookmarks to PDF with C# / .NET Core

Intro

If you are working with PDFs as a C# / .NET Core developer, you know the pain associated with working with them. In this post we will cover how to conveniently add bookmarks to a PDF using our REST API in just a few lines of code.

Our API will take your .pdf file and return back to you a new .pdf file with the bookmarks added. Just make sure your PDF is saved as a .pdf file and accessible at a URL that our service can ingest. For example, see this: http://www.api2pdf.com/wp-content/uploads/2021/01/1a082b03-2bd6-4703-989d-0443a88e3b0f-4.pdf — Ideally a file storage provider like S3 or Azure Blob Storage. See the code sample below.

Add bookmarks to PDF with C# / .NET Core

Step 1) Open up your package manager and run the command

Install-Package Api2Pdf -Version 2.0.0

Step 2) Grab an API key from https://portal.api2pdf.com. Only takes 60 seconds.

Step 3) Use the sample code below and replace “YOUR-API-KEY” with the api key you acquired in step 2.

var a2pClient = new Api2Pdf("YOUR-API-KEY");

var bookmarks = new List()
{
    new PdfBookmark
    {
        Page = 0,
        Title = "Introduction"
    },
    new PdfBookmark
    {
        Page = 1,
        Title = "Second Page"
    }
};
var request = new PdfBookmarkRequest
{
    Url = "http://link-to-your-pdf",
    Bookmarks = bookmarks
};
var apiResponse = a2pClient.PdfSharp.SetBookmarks(request);

And that’s it! Modify the code as you see fit. Hopefully this saves you time and makes adding bookmarks to PDF files easy and painless for those writing C# / .NET core code.

See full github library

We have a whole .net based client library for our API that does a lot more than just this. Check out the full library capabilities here: https://github.com/Api2Pdf/api2pdf.dotnet