Class PdfBookmark

Namespace

PDiffy

Assembly

PDiffy.dll

A bookmark. Page is set when it goes to a page of this document, Uri when it opens a web address and File when it opens another file.

public sealed record PdfBookmark : IEquatable<PdfBookmark>

Inheritance

object

PdfBookmark

Implements

IEquatable<PdfBookmark>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Action

The type of action it runs when that action doesn't open a page, another file or a web address, such as "JavaScript" or "Named"; null otherwise. PdfActionTypes lists the standard ones.

public string? Action { get; init; }

Property Value

string

ActionTarget

What its action acts on that Action doesn't say: a Named action's name; the fields a ResetForm or Hide action names, joined with commas, each a full name (or for a Hide, another annotation's /NM, or its type in parentheses), after "except:" when a ResetForm resets every field but those or "show:" when a Hide shows them; or the first 16 hex digits of a JavaScript action's script hash. "(unnamed)" for a field without a name, "(unknown)" for a reference to nothing and "(none)" for an empty list. Null otherwise.

public string? ActionTarget { get; init; }

Property Value

string

Bold

Whether its title is bold.

public bool Bold { get; init; }

Property Value

bool

Children

The bookmarks nested under it, in order; empty when there are none.

public required IReadOnlyList<PdfBookmark> Children { get; init; }

Property Value

IReadOnlyList<PdfBookmark>

Closed

Whether it opens with its children hidden; only a bookmark with children can.

public bool Closed { get; init; }

Property Value

bool

Color

The color of its title, such as "#ff0000"; null when it's black, the default.

public string? Color { get; init; }

Property Value

string

Destination

The page and view it opens: in this document, or in File. Only Name is set when it names a destination this PDF doesn't define, or any destination in another file.

public PdfDestination? Destination { get; init; }

Property Value

PdfDestination

File

The other file a GoToR or Launch action opens, or the address a SubmitForm action sends the form to.

public string? File { get; init; }

Property Value

string

Italic

Whether its title is italic.

public bool Italic { get; init; }

Property Value

bool

Page

The page it goes to in this document, counted from 1; null when it goes anywhere else or nowhere.

public required int? Page { get; init; }

Property Value

int?

Title

The text the bookmark shows, with runs of spaces, tabs and line breaks collapsed to one space.

public required string Title { get; init; }

Property Value

string

Uri

The web address it opens.

public string? Uri { get; init; }

Property Value

string