Get Started

API Reference

Class

PdfBookmarkEditSession

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:42
Modifiers sealed

Transactional add/remove/rename/move/nest/retarget/rebuild surface for existing bookmarks.

Inheritance

  • Object
  • PdfBookmarkEditSession

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Methods

public PdfBookmarkNode Add(String title, Int32 pageNumber, String parentId = null, Nullable<Double> destinationTop = null, Boolean expanded = true) #
OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:42
Returns: PdfBookmarkNode

Adds a bookmark at the root or below a parent id.

Parameters

title System.String requiredposition: 0
pageNumber System.Int32 requiredposition: 1
parentId System.String = null optionalposition: 2
destinationTop System.Nullable{System.Double} = null optionalposition: 3
expanded System.Boolean = true optionalposition: 4
public PdfBookmarkEditSession Move(String id, String parentId = null, Int32 index = -1) #
OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:50
Returns: PdfBookmarkEditSession

Moves a bookmark to a root or nested sibling position.

Parameters

id System.String requiredposition: 0
parentId System.String = null optionalposition: 1
index System.Int32 = -1 optionalposition: 2
public PdfBookmarkEditSession RebuildFromHeadings() #
OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:64
Returns: PdfBookmarkEditSession

Replaces bookmarks with the source document's inferred heading hierarchy.

public PdfBookmarkEditSession Remove(String id) #
OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:45
Returns: PdfBookmarkEditSession

Removes a bookmark and its descendants.

Parameters

id System.String requiredposition: 0
public PdfBookmarkEditSession Rename(String id, String title) #
OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:47
Returns: PdfBookmarkEditSession

Renames a bookmark.

Parameters

id System.String requiredposition: 0
title System.String requiredposition: 1
Retarget 2 overloads
public PdfBookmarkEditSession Retarget(String id, Int32 pageNumber, Nullable<Double> destinationTop = null) #
OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:59
Returns: PdfBookmarkEditSession

Retargets a bookmark to a page and optional top coordinate.

Parameters

id System.String requiredposition: 0
pageNumber System.Int32 requiredposition: 1
destinationTop System.Nullable{System.Double} = null optionalposition: 2
public PdfBookmarkEditSession Retarget(String id, Int32 pageNumber, PdfOpenActionDestinationMode destinationMode, Nullable<Double> destinationTop = null, Nullable<Double> destinationLeft = null, Nullable<Double> destinationBottom = null, Nullable<Double> destinationRight = null, Nullable<Double> destinationZoom = null) #
OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:61
Returns: PdfBookmarkEditSession

Retargets a bookmark using an explicit viewer destination mode and coordinates.

Parameters

id System.String requiredposition: 0
pageNumber System.Int32 requiredposition: 1
destinationMode OfficeIMO.Pdf.PdfOpenActionDestinationMode requiredposition: 2
destinationTop System.Nullable{System.Double} = null optionalposition: 3
destinationLeft System.Nullable{System.Double} = null optionalposition: 4
destinationBottom System.Nullable{System.Double} = null optionalposition: 5
destinationRight System.Nullable{System.Double} = null optionalposition: 6
destinationZoom System.Nullable{System.Double} = null optionalposition: 7

Properties

public IReadOnlyList<PdfBookmarkNode> Roots { get; } #
OfficeIMO.Pdf/Manipulation/PdfBookmarkEditSession.cs:39

Current top-level bookmark nodes.