Class PdfBookMark
Represents a PDF bookmark as seen in the sidebar of PDF reader software to help user's navigate.
Inheritance
Namespace: IronPdf.Bookmarks
Assembly: IronPdf.dll
Syntax
public class PdfBookMark : Object, IPdfBookmarkProperties
Children
Bookmarks contained under this bookmark
Declaration
public IPdfBookMarkCollection Children { get; }Property Value
| Type | Description |
|---|---|
| IPdfBookMarkCollection |
DestinationType
Type of destination represented by the bookmark
Declaration
public virtual BookmarkDestinations DestinationType { get; }Property Value
| Type | Description |
|---|---|
| BookmarkDestinations |
NextBookmark
Next bookmark at the current level, if any
Declaration
public IPdfBookmark NextBookmark { get; }Property Value
| Type | Description |
|---|---|
| IronPdf.Bookmarks.IPdfBookmark |
PageIndex
The zero based page number that the bookmark links to.
Declaration
public int PageIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The index of the page. |
Parent
Bookmark which contains this bookmark
Declaration
public IPdfBookmark Parent { get; }Property Value
| Type | Description |
|---|---|
| IronPdf.Bookmarks.IPdfBookmark |
ParentText
Parent bookmark text
Declaration
public string ParentText { get; }Property Value
| Type | Description |
|---|---|
| System.String |
PreviousBookmark
Previous bookmark at the current level, if any
Declaration
public IPdfBookmark PreviousBookmark { get; }Property Value
| Type | Description |
|---|---|
| IronPdf.Bookmarks.IPdfBookmark |
PreviousText
Previous bookmark text
Declaration
public string PreviousText { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Siblings
Bookmarks contained at the same level and under the same parent as this bookmark
Declaration
public IPdfBookMarkCollection Siblings { get; }Property Value
| Type | Description |
|---|---|
| IPdfBookMarkCollection |
Text
The display text of the bookmark
Declaration
public string Text { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
InsertBookMarkAfter(String, Int32)
Insert a new bookmark after the specified bookmark
Declaration
public IPdfBookmark InsertBookMarkAfter(string text, int pageIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | text | The display text for the link. |
| System.Int32 | pageIndex | The zero based page number to link to. E.g. Page 1 has a PageIndex of 0 |
Returns
| Type | Description |
|---|---|
| IronPdf.Bookmarks.IPdfBookmark |
InsertBookMarkBefore(String, Int32)
Insert a new bookmark after the specified bookmark
Declaration
public IPdfBookmark InsertBookMarkBefore(string text, int pageIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | text | The display text for the link. |
| System.Int32 | pageIndex | The zero based page number to link to. E.g. Page 1 has a PageIndex of 0 |
Returns
| Type | Description |
|---|---|
| IronPdf.Bookmarks.IPdfBookmark |