Class DocxCheckFinding
- Namespace
- PDiffy
- Assembly
- PDiffy.dll
Something a DocxCheck found: where it is and what's wrong. The path is the one a snapshot diff shows for the item's line, such as "body > Table > Row[2] > Cell > P > image", or "document" for the whole document.
public sealed record DocxCheckFinding : IEquatable<DocxCheckFinding>- Inheritance
-
DocxCheckFinding
- Implements
- Inherited Members
Properties
Category
The family the rule belongs to, such as alt text.
public required DocxCheckCategory Category { get; init; }Property Value
Check
The rule that found it.
public required DocxCheck Check { get; init; }Property Value
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
Message
What's wrong, as a sentence with no closing period, such as "Image has no alt text".
public required string Message { get; init; }Property Value
Path
Where it is: the path a snapshot diff shows for the item's line, such as "headers > s1 > P > image", or a section's name alone, such as "document", for the whole document.
public required string Path { get; init; }Property Value
Reference
The WCAG 2.2 success criterion the rule comes from, such as "WCAG 2.2 1.1.1". It says where the rule comes from; it doesn't say the document conforms to WCAG.
public required string Reference { get; init; }Property Value
Severity
How much it matters: an error for a rule that breaks a WCAG 2.2 success criterion, a warning for one that usually does, such as a table with no header row, which might be for layout.
public required CheckSeverity Severity { get; init; }Property Value
Methods
ToString()
Such as "ImageAltText (WCAG 2.2 1.1.1): Image has no alt text (body > P[3] > image)".
public override string ToString()