Class PdfBookmarkEntry

Represents a bookmark (outline) entry in the exported PDF. Excel UI: worksheet-level bookmarks in the PDF bookmarks panel.

Inheritance

object

PdfBookmarkEntry

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DRIT.Spreadsheet.Export.Pdf

Assembly: DRIT.Spreadsheet.dll

Syntax

public class PdfBookmarkEntry

Remarks

When BookmarkEntries is populated, these entries override the default per-sheet bookmarks. Each entry specifies a display title and the sheet (by index) that the bookmark navigates to.

Constructors

PdfBookmarkEntry()

Creates a new, empty bookmark entry.

Declaration

public PdfBookmarkEntry()

Remarks

When BookmarkEntries is populated, these entries override the default per-sheet bookmarks. Each entry specifies a display title and the sheet (by index) that the bookmark navigates to.

PdfBookmarkEntry(string, int)

Creates a new bookmark entry with the specified title and sheet index.

Declaration

public PdfBookmarkEntry(string title, int sheetIndex)

Parameters

Type	Name	Description
string	title	The display title.
int	sheetIndex	The zero-based sheet index to navigate to.

Remarks

When BookmarkEntries is populated, these entries override the default per-sheet bookmarks. Each entry specifies a display title and the sheet (by index) that the bookmark navigates to.

Properties

ChildEntry

Specifies the bookmark entry that is a child of this entry. When null, the bookmark has no children.

Declaration

public PdfBookmarkEntry ChildEntry { get; set; }

Property Value

Type	Description
PdfBookmarkEntry

Remarks

When BookmarkEntries is populated, these entries override the default per-sheet bookmarks. Each entry specifies a display title and the sheet (by index) that the bookmark navigates to.

SheetIndex

Specifies the zero-based sheet index that this bookmark navigates to. The bookmark targets the first page of that sheet.

Declaration

public int SheetIndex { get; set; }

Property Value

Type	Description
int

Remarks

When BookmarkEntries is populated, these entries override the default per-sheet bookmarks. Each entry specifies a display title and the sheet (by index) that the bookmark navigates to.

Title

Specifies the display title shown in the PDF bookmarks panel.

Declaration

public string Title { get; set; }

Property Value

Type	Description
string

Remarks

When BookmarkEntries is populated, these entries override the default per-sheet bookmarks. Each entry specifies a display title and the sheet (by index) that the bookmark navigates to.