zplCore.comzplCore.com

ZplCheckOptions

public sealed class ZplCheckOptions

Options of ZplCheck.Run (the zplcore check command line).

Constructors

SignatureDescription
# ZplCheckOptions()

Properties

PropertyTypeDescription
BaselineDirectory { get; set; }stringFolder with the baseline version of the files (same relative paths), e.g. the PR base checked out by the action.
DisabledRules { get; set; }IReadOnlyCollection<string>Compliance rules to switch off.
Dpi { get; set; }intPrint resolution (default 203 dpi).
FailOn { get; set; }CheckSeverity?Lowest severity that fails the run (null: never fail on findings).
FieldValues { get; set; }IReadOnlyDictionary<int, string>Values for ^FN fields.
HeightMm { get; set; }doubleLabel height when the ZPL has no ^LL (default 6 in).
Inputs { get; set; }IReadOnlyList<string>Files and glob patterns (**/*.zpl, !**/drafts/**); default LabelSource.DefaultPatterns.
Layout { get; set; }boolCheck overlaps (ZT1101) and clipping (ZT1102).
LayoutSeverity { get; set; }CheckSeveritySeverity of layout findings (default warning).
MinGrade { get; set; }ScanProofGrade?With ZplCheckOptions.Verify: fail barcodes below this grade (ZT1301).
Packs { get; set; }IReadOnlyList<ComplianceRulePack>Compliance packs to run (none by default).
Printer { get; set; }IZplPrinterFitPrinter to check against (ZT1201–ZT1203 or the implementation's ids).
ReportDirectory { get; set; }stringFolder for before/after/diff PNGs of changed files and the report files.
Root { get; set; }stringRoot for patterns and relative paths in reports (default: current directory).
SnapshotDirectory { get; set; }stringSnapshot folder: compare every file with its approved snapshot (name = relative path).
SnapshotTolerance { get; set; }SnapshotTolerancePixel tolerance of the snapshot comparison.
UpdateSnapshots { get; set; }boolWrite the current renders as approved snapshots instead of comparing.
Verify { get; set; }boolRun scan-proof: decode every barcode, measure, grade.
WidthMm { get; set; }doubleLabel width when the ZPL has no ^PW (default 4 in).