Class ReportConfiguration
The class used for configuring the report.
Implements
Namespace: HP.LFT.Report
Assembly: HP.LFT.Report.dll
Syntax
public class ReportConfiguration : BaseConfiguration, IReportConfigurationConstructors
ReportConfiguration()
Initializes a new instance of the ReportConfiguration class that is initialized with the report configuration values from the local assembly's app.config file.
Declaration
public ReportConfiguration()ReportConfiguration(Assembly)
Initializes a new instance of the ReportConfiguration class with the assembly value of type System.Configuration.Assembly.
Declaration
public ReportConfiguration(Assembly assembly)Parameters
| Type | Name | Description |
|---|---|---|
| Assembly | assembly | The System.Configuration.Assembly containing the app.config whose report configuration you want to use. |
Remarks
Using this constructor is useful if you want multiple assemblies to all use the report configuration settings from a central app.config file.
Properties
Description
the report description.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Remarks
The description appears directly below the title in the report. By default, the description is empty.
IsJUnitEnabled
The boolean value indicating if the JUnit report will be generated or not.
Declaration
public bool IsJUnitEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsOverrideExisting
Indicates whether the existing report files will be overridden. If false, each report filename gets an ordinal suffix.
Declaration
public bool IsOverrideExisting { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
ReportEnabled
Specifies if the report should be enabled or not.
Declaration
public bool ReportEnabled { get; }Property Value
| Type | Description |
|---|---|
| bool |
Remarks
Default = true
ReportFolder
The name of the folder where the report is generated.
Declaration
public string ReportFolder { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Remarks
Default = RunResults
ReportLevel
The level of events to be reported. Possible values: ReportLevel.
Declaration
public ReportLevel ReportLevel { get; set; }Property Value
| Type | Description |
|---|---|
| ReportLevel |
SeparateReport
Defines the report separation.
Declaration
public ReportGranularity SeparateReport { get; set; }Property Value
| Type | Description |
|---|---|
| ReportGranularity |
Remarks
Default = Off
SnapshotsLevel
The snapshot capture level used to generate the report.
Declaration
public CaptureLevel SnapshotsLevel { get; set; }Property Value
| Type | Description |
|---|---|
| CaptureLevel |
Remarks
Possible values: CaptureLevel
TargetDirectory
The root directory where report folders are generated. Default = project Output path.
Declaration
public string TargetDirectory { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Title
the report title.
Declaration
public string Title { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Remarks
Default = Run Results