Class Bookmark
Represents a bookmark in a document. A bookmark is an object that registers a PDF action, usually triggered to go to a page. GoTo.
Inheritance
System.Object
Bookmark
Namespace: PSPDFKit.Pdf
Assembly: PSPDFKit.dll
Syntax
public sealed class Bookmark
Constructors
Bookmark(String, IAction)
Constructs a Bookmark.
Declaration
public Bookmark(string name, IAction action)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the bookmark. |
IAction | action | The action to perform on the bookmark. |
Properties
Action
The action the bookmark triggers. Usually to go to a page. GoTo.
Declaration
public IAction Action { get; set; }
Property Value
Type | Description |
---|---|
IAction |
Id
A unique identifier to describe the bookmark. This identifier is generated by the framework if left blank.
Declaration
public string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Name
The name of the bookmark.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
FromJson(JsonObject)
Create a bookmark from json.
Declaration
public static Bookmark FromJson(JsonObject json)
Parameters
Type | Name | Description |
---|---|---|
Windows.Data.Json.JsonObject | json | The json representing the bookmark. |
Returns
Type | Description |
---|---|
Bookmark | A Bookmark. |
ToJson()
Converts the Bookmark to a Windows.Data.Json.JsonObject.
Declaration
public JsonObject ToJson()
Returns
Type | Description |
---|---|
Windows.Data.Json.JsonObject | The bookmark as json. |