Class ProtoWorkbook

Namespace

ProtoTest.Sheets

Assembly

ProtoTest.Sheets.dll

An opened workbook. Reading is eager and complete: tests assert on values, so a missing sheet or reference must fail with a clear message rather than a lazy parser error later.

public sealed class ProtoWorkbook

Inheritance

object

ProtoWorkbook

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Properties

Name

The file name the workbook was opened from.

public string Name { get; }

Property Value

string

Sheets

The sheets that were read. Hidden sheets are omitted unless IncludeHiddenSheets is set, so the count reflects visible sheets by default; each sheet still carries its position in the workbook in Index.

public IReadOnlyList<ProtoSheet> Sheets { get; }

Property Value

IReadOnlyList<ProtoSheet>

Methods

Model<TRow>()

Binds a record with [Sheet]/[Column] attributes to this workbook. The record is the model: the layout is declared once and the tests read typed rows.

public ProtoSheetModel<TRow> Model<TRow>() where TRow : notnull

Returns

ProtoSheetModel<TRow>

Type Parameters

TRow

Sheet(string)

Finds a sheet by name; the failure lists the sheets that do exist.

public ProtoSheet Sheet(string name)

Parameters

name string

Returns

ProtoSheet