Interface IGetsReportFormat

Namespace: CSF.Screenplay.Reporting

Assembly: CSF.Screenplay.Abstractions.dll

An object which can get a ReportFormat from a report format template and the associated values.

public interface IGetsReportFormat

Methods

GetReportFormat(string, IList<object>)

Gets a ReportFormat instance from the specified template and collection of values.

ReportFormat GetReportFormat(string template, IList<object> values)

Parameters

template string: The original report format template
values IList<object>: An ordered collection of placeholder values to be used with the template

Returns

ReportFormat: An instance of ReportFormat which combines the template and the values.

Remarks

The template is intended to be a human-readable string, with value placeholders enclosed within braces. The values is a collection of data values to be used as the 'filler' for those placeholders. The order in which the values are provided is important, as the placeholders will be filled in the order in which they appear in the template string. Note that duplicate placeholders will receive the same value and do not require the value to be repeated in the values collection.

Exceptions

ArgumentNullException: If any parameter is null.