HtmlReporterSettings Class

This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Newman.

Summary

Settings for the HTML reporter.

Assembly

Cake.Newman.dll

Namespace

Cake.Newman.Reporters

Interfaces

IReporterSettings

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["IReporterSettings"] click Interface0 "/api/Cake.Newman.Reporters/IReporterSettings" Type["HtmlReporterSettings"] class Type type-node

Syntax

public class HtmlReporterSettings : IReporterSettings

Constructors

Name	Summary
HtmlReporterSettings()

Properties

Name	Value	Summary
OutputFile	FilePath	Path where the output HTML file will be written to disk.
TemplateFile	FilePath	Path to the custom template which will be used to render the HTML report.

Methods

Name	Value	Summary
RenderOptions(ProcessArgumentBuilder)	void	Outputs the reporter-specific settings to include in the invocation

Extension Methods

Name	Value	Summary
Dump<HtmlReporterSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<HtmlReporterSettings>(HtmlReporterSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<HtmlReporterSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<HtmlReporterSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<HtmlReporterSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<HtmlReporterSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin
UseOutputFile(FilePath)	HtmlReporterSettings	Specify a path where the output HTML file will be written to disk. From HtmlReporterSettingsExtensions Requires the Cake.Newman addin
UseTemplateFile(FilePath)	HtmlReporterSettings	Specify a path to the custom template which will be used to render the HTML report. From HtmlReporterSettingsExtensions Requires the Cake.Newman addin