Class DocxCheckSet

Namespace

PDiffy

Assembly

PDiffy.dll

A set of DocxCheck rules for Check(DocxCheckSet). Latest grows as PDiffy adds rules, so an upgrade can fail a test that passed; a release's own set, such as Version1_0, never changes, so upgrading adds no rules until a test moves to a newer set.

public sealed class DocxCheckSet

Inheritance

object

DocxCheckSet

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Checks

The rules in the set, in the order DocxCheck declares them.

public IReadOnlyList<DocxCheck> Checks { get; }

Property Value

IReadOnlyList<DocxCheck>

Latest

Every rule in the installed version of PDiffy, as Check() with no arguments applies.

public static DocxCheckSet Latest { get; }

Property Value

DocxCheckSet

Name

The set's name: "latest", or the release it keeps the rules of, such as "1.0".

public string Name { get; }

Property Value

string

Version1_0

The rules PDiffy 1.0 shipped. It never changes.

public static DocxCheckSet Version1_0 { get; }

Property Value

DocxCheckSet

Methods

Except(params DocxCheck[])

The rules in this set other than the ones given, as a set with the same name.

public DocxCheckSet Except(params DocxCheck[] checks)

Parameters

checks DocxCheck[]

Returns

DocxCheckSet

Only(DocxCheckCategory, params DocxCheckCategory[])

The rules in this set that belong to one of the categories, as a set with the same name.

public DocxCheckSet Only(DocxCheckCategory category, params DocxCheckCategory[] more)

Parameters

category DocxCheckCategory

more DocxCheckCategory[]

Returns

DocxCheckSet

ToString()

The name and how many rules the set has, such as "latest, 4 rules".

public override string ToString()

Returns

string