Class PdfCheckFinding

Namespace

PDiffy

Assembly

PDiffy.dll

Something a PdfCheck found: where it is, its page when it has one, and what's wrong. The path names the snapshot section and the item: for a structure element, the path a snapshot diff shows, such as "structure > Document > Figure[2]".

public sealed record PdfCheckFinding : IEquatable<PdfCheckFinding>

Inheritance

object

PdfCheckFinding

Implements

IEquatable<PdfCheckFinding>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Category

The family the rule belongs to, such as tables or fonts.

public required PdfCheckCategory Category { get; init; }

Property Value

PdfCheckCategory

Check

The rule that found it.

public required PdfCheck Check { get; init; }

Property Value

PdfCheck

HelpUrl

The rule's entry on the docs site: what it finds, why it matters to someone using assistive technology, and how to fix it.

public string HelpUrl { get; }

Property Value

string

Message

What's wrong, as a sentence with no closing period, such as "Font Helvetica isn't embedded".

public required string Message { get; init; }

Property Value

string

Page

The page number, counted from 1; null when the finding is about the whole document, such as a missing language or a font that isn't embedded, or when its item's page isn't known.

public required int? Page { get; init; }

Property Value

int?

Path

Where it is: a section's name alone, such as "metadata", or with the item, such as "fonts > Helvetica" or "forms

trail.name".

public required string Path { get; init; }

Property Value

string

Reference

The clause the finding comes from, such as "ISO 14289-1 7.3" (PDF/UA-1); null for a house rule. It's usually the rule's own clause, but can be another one when the rule covers more than one. It says where the rule comes from, not that the document conforms to the standard.

public required string? Reference { get; init; }

Property Value

string

Severity

How much it matters: an error for a rule PDF/UA requires, a warning otherwise.

public required CheckSeverity Severity { get; init; }

Property Value

CheckSeverity

Methods

ToString()

Such as "FigureAltText (ISO 14289-1 7.3): Figure on p2 has no alt text (structure > Document > Figure[2])". A house rule has no clause: "NoActions: The document has JavaScript (settings > javascript)".

public override string ToString()

Returns

string