Class PdfDocumentInfo

Namespace

PDiffy

Assembly

PDiffy.dll

What the PDF's catalog says about the document as a whole, and its page count.

public sealed record PdfDocumentInfo : IEquatable<PdfDocumentInfo>

Inheritance

object

PdfDocumentInfo

Implements

IEquatable<PdfDocumentInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DisplayDocTitle

Whether a viewer shows the metadata's title in its title bar, not the file name.

public required bool DisplayDocTitle { get; init; }

Property Value

bool

HasStructureTree

Whether the catalog has a structure tree root (StructTreeRoot). A snapshot shows a missing root as an empty structure section, as it does an empty tree.

public bool HasStructureTree { get; init; }

Property Value

bool

Language

The document's default language, such as "en-US"; null when it doesn't set one.

public required string? Language { get; init; }

Property Value

string

Marked

Whether the PDF says it's tagged (MarkInfo's Marked).

public required bool Marked { get; init; }

Property Value

bool

PageCount

How many pages the document has, including any that couldn't be loaded.

public required int PageCount { get; init; }

Property Value

int

ParentTreeMissing

Whether structure elements own content but the structure tree has no parent tree (ParentTree), which assistive technology uses to go from content back to its tag.

public bool ParentTreeMissing { get; init; }

Property Value

bool

ParentTreeProblems

What's wrong with the parent tree's keys, which a reader searches to go from content back to its tag, in the order of PdfParentTreeProblem; empty when nothing is.

public IReadOnlyList<PdfParentTreeProblem> ParentTreeProblems { get; init; }

Property Value

IReadOnlyList<PdfParentTreeProblem>

Suspects

Whether MarkInfo says the tags may not be reliable (Suspects), as a tool that guessed them sets it.

public bool Suspects { get; init; }

Property Value

bool

UnreadableObjects

How many objects the document refers to that PDiffy couldn't read, such as one missing from the file or too damaged to parse. Each reads as nothing, so what it held, such as a bookmark or an annotation, is left out.

public int UnreadableObjects { get; init; }

Property Value

int