Interface IPdfBookMarkCollection

Namespace: IronPdf.Bookmarks

Assembly: IronPdf.dll

Syntax

public interface IPdfBookMarkCollection

PDF bookmarks in IronPDF is exposed through the IPdfBookMarkCollection contract. It is the IronPDF contract for PDF bookmarks, so code can work with PDF bookmarks uniformly across implementors rather than binding to a concrete type.

Concrete implementors include PdfBookMarkCollection, IronPDF concrete implementor. Code that accepts IPdfBookMarkCollection works uniformly across these implementors, so applications can read or configure C# PDF features without binding to a specific concrete type.

Most of the usable surface is inherited. The members that carry everyday use of this contract are Count, FirstBookmark, LastBookmark, Parent; consult these first when implementing or consuming IPdfBookMarkCollection. The bookmarks walks through typical use in the IronPDF C# documentation.

using IronPdf;

// IPdfBookMarkCollection is consumed as the API surface for the family of implementors
void Consume(IPdfBookMarkCollection target)
{
    // Use members defined on the interface; concrete behavior follows the implementor
}

For collection-wide operations and end-to-end examples, see the IronPDF C# documentation for related guides. For collection-wide operations on IPdfBookMarkCollection instances, the IronPDF C# documentation lists the relevant container types and their methods. Concrete behavior depends on which implementor of IPdfBookMarkCollection is returned at runtime; consult the specific class reference for type-specific members. Polymorphic access through IPdfBookMarkCollection lets code work uniformly across the family of implementors, with a cast required only when type-specific behavior is needed. The reference tables below list the full set of members defined on IPdfBookMarkCollection along with any inherited members exposed through the contract. In a typical IronPDF C# workflow, IPdfBookMarkCollection appears as a parameter or return type at the boundary between the application and the IronPDF API. See the methods table below for the complete set of members defined directly on IPdfBookMarkCollection. Implementing IPdfBookMarkCollection directly in application code is uncommon; the typical pattern is to consume instances returned from the IronPDF API.

Properties

Count

Declaration

int Count { get; }

Property Value

Type	Description
System.Int32

FirstBookmark

Declaration

IPdfBookmark FirstBookmark { get; }

Property Value

Type	Description
IronPdf.Bookmarks.IPdfBookmark

LastBookmark

Declaration

IPdfBookmark LastBookmark { get; }

Property Value

Type	Description
IronPdf.Bookmarks.IPdfBookmark

Parent

Declaration

IPdfBookmark Parent { get; }

Property Value

Type	Description
IronPdf.Bookmarks.IPdfBookmark

Methods

AddBookMarkAtEnd(String, Int32)

Declaration

IPdfBookmark AddBookMarkAtEnd(string text, int pageIndex)

Parameters

Type	Name	Description
System.String	text
System.Int32	pageIndex

Returns

Type	Description
IronPdf.Bookmarks.IPdfBookmark

AddBookMarkAtStart(String, Int32)

Declaration

IPdfBookmark AddBookMarkAtStart(string text, int pageIndex)

Parameters

Type	Name	Description
System.String	text
System.Int32	pageIndex

Returns

Type	Description
IronPdf.Bookmarks.IPdfBookmark

GetAllBookmarks()

Declaration

List<IPdfBookmark> GetAllBookmarks()

Returns

Type	Description
System.Collections.Generic.List<IronPdf.Bookmarks.IPdfBookmark>

GetBookmarkAfter(IPdfBookmark)

Declaration

IPdfBookmark GetBookmarkAfter(IPdfBookmark previousBookmark)

Parameters

Type	Name	Description
IronPdf.Bookmarks.IPdfBookmark	previousBookmark

Returns

Type	Description
IronPdf.Bookmarks.IPdfBookmark

GetBookmarkBefore(IPdfBookmark)

Declaration

IPdfBookmark GetBookmarkBefore(IPdfBookmark nextBookmark)

Parameters

Type	Name	Description
IronPdf.Bookmarks.IPdfBookmark	nextBookmark

Returns

Type	Description
IronPdf.Bookmarks.IPdfBookmark

GetEnumerator()

Declaration

IEnumerator<IPdfBookmark> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<IronPdf.Bookmarks.IPdfBookmark>

InsertBookMarkAfter(String, Int32, IPdfBookmark)

Declaration

IPdfBookmark InsertBookMarkAfter(string text, int pageIndex, IPdfBookmark previousBookmark)

Parameters

Type	Name	Description
System.String	text
System.Int32	pageIndex
IronPdf.Bookmarks.IPdfBookmark	previousBookmark

Returns

Type	Description
IronPdf.Bookmarks.IPdfBookmark

InsertBookMarkBefore(String, Int32, IPdfBookmark)

Declaration

IPdfBookmark InsertBookMarkBefore(string text, int pageIndex, IPdfBookmark nextBookmark)

Parameters

Type	Name	Description
System.String	text
System.Int32	pageIndex
IronPdf.Bookmarks.IPdfBookmark	nextBookmark

Returns

Type	Description
IronPdf.Bookmarks.IPdfBookmark

RemoveBookMark(IPdfBookmark)

Declaration

void RemoveBookMark(IPdfBookmark bookmark)

Parameters

Type	Name	Description
IronPdf.Bookmarks.IPdfBookmark	bookmark

RemoveBookMarkAt(Int32)

Declaration

void RemoveBookMarkAt(int index)

Parameters

Type	Name	Description
System.Int32	index