Add and Delete a Bookmark

The following code snippet also work with Aspose.PDF.Drawing library.

Add a Bookmark to a PDF Document

Bookmarks are held in the Document object’s OutlineItemCollection collection, itself in the OutlineCollection collection.

To add a bookmark to a PDF:

1. Open a PDF document using Document object.
2. Create a bookmark and define its properties.
3. Add the OutlineItemCollection collection to the Outlines collection.

The following code snippet shows you how to add a bookmark in a PDF document.

.NET Core 3.1

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET

private static void AddBookmark()
{
    // The path to the documents directory
    string dataDir = RunExamples.GetDataDir_AsposePdf_Bookmarks();

    // Open document
    using (var document = new Aspose.Pdf.Document(dataDir + "AddBookmark.pdf"))
    {
        // Create a bookmark object
        var pdfOutline = new Aspose.Pdf.OutlineItemCollection(document.Outlines);
        pdfOutline.Title = "Test Outline";
        pdfOutline.Italic = true;
        pdfOutline.Bold = true;

        // Set the destination page number
        pdfOutline.Action = new Aspose.Pdf.Annotations.GoToAction(document.Pages[1]);

        // Add bookmark in the document's outline collection.
        document.Outlines.Add(pdfOutline);

        // Save output
        document.Save(dataDir + "AddBookmark_out.pdf");
    }
}

.NET 8

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET

private static void AddBookmark()
{
    // The path to the documents directory
    string dataDir = RunExamples.GetDataDir_AsposePdf_Bookmarks();

    // Open document
    using var document = new Aspose.Pdf.Document(dataDir + "AddBookmark.pdf");

    // Create a bookmark object
    var pdfOutline = new Aspose.Pdf.OutlineItemCollection(document.Outlines);
    pdfOutline.Title = "Test Outline";
    pdfOutline.Italic = true;
    pdfOutline.Bold = true;

    // Set the destination page number
    pdfOutline.Action = new Aspose.Pdf.Annotations.GoToAction(document.Pages[1]);

    // Add bookmark in the document's outline collection.
    document.Outlines.Add(pdfOutline);

    // Save output
    document.Save(dataDir + "AddBookmark_out.pdf");
}

Add a Child Bookmark to the PDF Document

Bookmarks can be nested, indicating a hierarchical relationship with parent and child bookmarks. This article explains how to add a child bookmark, that is, a second-level bookmark, to a PDF.

To add a child bookmark to a PDF file, first add a parent bookmark:

1. Open a document.
2. Add a bookmark to the OutlineItemCollection, defining its properties.
3. Add the OutlineItemCollection to the Document object’s OutlineCollection collection.

The child bookmark is created just like the parent bookmark, explained above, but is added to the parent bookmark’s Outlines collection

The following code snippets show how to add child bookmark to a PDF document.

.NET Core 3.1

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET

private static void AddChildBookmark()
{
    // The path to the documents directory
    string dataDir = RunExamples.GetDataDir_AsposePdf_Bookmarks();

    // Open document
    using (var document = new Aspose.Pdf.Document(dataDir + "AddChildBookmark.pdf"))
    {
        // Create a parent bookmark object
        var pdfOutline = new Aspose.Pdf.OutlineItemCollection(document.Outlines);
        pdfOutline.Title = "Parent Outline";
        pdfOutline.Italic = true;
        pdfOutline.Bold = true;

        // Create a child bookmark object
        var pdfChildOutline = new Aspose.Pdf.OutlineItemCollection(document.Outlines);
        pdfChildOutline.Title = "Child Outline";
        pdfChildOutline.Italic = true;
        pdfChildOutline.Bold = true;

        // Add child bookmark in parent bookmark's collection
        pdfOutline.Add(pdfChildOutline);

        // Add parent bookmark in the document's outline collection.
        document.Outlines.Add(pdfOutline);

        // Save output
        document.Save(dataDir + "AddChildBookmark_out.pdf");
    }
}

.NET 8

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET

private static void AddChildBookmark()
{
    // The path to the documents directory
    string dataDir = RunExamples.GetDataDir_AsposePdf_Bookmarks();

    // Open document
    using var document = new Aspose.Pdf.Document(dataDir + "AddChildBookmark.pdf");

    // Create a parent bookmark object
    var pdfOutline = new Aspose.Pdf.OutlineItemCollection(document.Outlines);
    pdfOutline.Title = "Parent Outline";
    pdfOutline.Italic = true;
    pdfOutline.Bold = true;

    // Create a child bookmark object
    var pdfChildOutline = new Aspose.Pdf.OutlineItemCollection(document.Outlines);
    pdfChildOutline.Title = "Child Outline";
    pdfChildOutline.Italic = true;
    pdfChildOutline.Bold = true;

    // Add child bookmark in parent bookmark's collection
    pdfOutline.Add(pdfChildOutline);

    // Add parent bookmark in the document's outline collection.
    document.Outlines.Add(pdfOutline);

    // Save output
    document.Save(dataDir + "AddChildBookmark_out.pdf");
}

Delete all Bookmarks from a PDF Document

All bookmarks in a PDF are held in the OutlineCollection collection. This article explains how to delete all bookmarks from a PDF file.

To delete all bookmarks from a PDF file:

1. Call the OutlineCollection collection’s Delete method.
2. Save the modified file using the Document object’s Save method.

The following code snippets show how to delete all bookmarks from a PDF document.

.NET Core 3.1

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET

private static void DeleteBookmarks()
{
    // The path to the documents directory
    string dataDir = RunExamples.GetDataDir_AsposePdf_Bookmarks();

    // Open document
    using (var document = new Aspose.Pdf.Document(dataDir + "DeleteAllBookmarks.pdf"))
    {
        // Delete all bookmarks
        document.Outlines.Delete();

        // Save updated file
        document.Save(dataDir + "DeleteAllBookmarks_out.pdf");
    }
}

.NET 8

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET

private static void DeleteBookmarks()
{
    // The path to the documents directory
    string dataDir = RunExamples.GetDataDir_AsposePdf_Bookmarks();

    // Open document
    using var document = new Aspose.Pdf.Document(dataDir + "DeleteAllBookmarks.pdf");

    // Delete all bookmarks
    document.Outlines.Delete();

    // Save updated file
    document.Save(dataDir + "DeleteAllBookmarks_out.pdf");
}

Delete a Particular Bookmark from a PDF Document

To delete a particular bookmark from a PDF file:

1. Pass the bookmark’s title as parameter to the OutlineCollection collection’s Delete method.
2. Then save the updated file with the Document object Save method.

The Document class’ provides the OutlineCollection collection. The Delete method removes any bookmark with the title passed to the method.

The following code snippets show how to delete a particular bookmark from the PDF document.

.NET Core 3.1

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET

private static void DeleteBookmark()
{
    // The path to the documents directory
    string dataDir = RunExamples.GetDataDir_AsposePdf_Bookmarks();

    // Open document
    using (var document = new Aspose.Pdf.Document(dataDir + "DeleteParticularBookmark.pdf"))
    {
        // Delete particular outline by Title
        document.Outlines.Delete("Child Outline");

        // Save updated file
        document.Save(dataDir + "DeleteParticularBookmark_out.pdf");
    }
}

.NET 8

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET

private static void DeleteBookmark()
{
    // The path to the documents directory
    string dataDir = RunExamples.GetDataDir_AsposePdf_Bookmarks();

    // Open document
    using var document = new Aspose.Pdf.Document(dataDir + "DeleteParticularBookmark.pdf");

    // Delete particular outline by Title
    document.Outlines.Delete("Child Outline");

    // Save updated file
    document.Save(dataDir + "DeleteParticularBookmark_out.pdf");
}