Skip to main content

Class PdfValidationFinding

Namespace: AdCodicem.Pdf.Validation
Assembly: AdCodicem.Pdf.dll

One thing a validation rule found wrong with a document, or worth knowing about it.

public sealed record PdfValidationFinding : IEquatable<PdfValidationFinding>

Inheritance​

object ← PdfValidationFinding

Implements​

IEquatable<PdfValidationFinding>

Inherited Members​

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Remarks​

A finding is the validator's verdict on the file, where a PdfDiagnostic is the reader's account of what it did to read it. Its PdfValidationFinding.RuleId is the stable part: callers filter on it, and repair keys its remedies off it. The message and the remedy are for people, and may be reworded.

Properties​

Location​

Gets where in the document the finding applies.

public PdfValidationLocation Location { get; }

Property Value​

PdfValidationLocation

Message​

Gets a human-readable explanation, in English.

public string Message { get; }

Property Value​

string

Remedy​

Gets what would put it right, as a hint rather than an action — so that a report reads as a plan — or null when there is nothing to put right.

public string? Remedy { get; }

Property Value​

string?

RuleId​

Gets the identifier of the rule that found it, one of PdfValidationRuleIds: stable, and part of the public contract.

public string RuleId { get; }

Property Value​

string

Severity​

Gets how wrong the finding says the document is. A rule always reports at the same severity.

public PdfValidationSeverity Severity { get; }

Property Value​

PdfValidationSeverity

Methods​

ToString()​

Returns a string that represents the current object.

public override string ToString()

Returns​

string

A string that represents the current object.