Class ObjectComparisonReportGenerator

Namespace

ArcanaDevelopment.adTempus.Shared.ObjectComparison

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Creates a report showing the results of an object comparison operation.

public class ObjectComparisonReportGenerator

Inheritance

object

ObjectComparisonReportGenerator

Constructors

ObjectComparisonReportGenerator()

public ObjectComparisonReportGenerator()

Properties

EmptyValue

Specifies the value to write to represent an empty or missing value.

public string EmptyValue { get; set; }

Property Value

string

Remarks

Defaults to non-breaking space ( ) to preserve cell borders in tables.

LeftObjectDescription

Set the text to be used in the report column header for the "left" object. Defaults to "Source".

public string LeftObjectDescription { get; set; }

Property Value

string

ReportType

Gets or sets the format of the report to produce.

public ComparisonReportType ReportType { get; set; }

Property Value

ComparisonReportType

Remarks

For an HTML report, the returned report is an HTML fragment only (it does not include html, head, or body tags). It is the responsibility of the consumer to embed the fragment in a valid HTML document and add CSS definitions to style the report.

RightObjectDescription

Set the text to be used in the report column header for the "right" object. Defaults to "Target".

public string RightObjectDescription { get; set; }

Property Value

string

Methods

GenerateReport(ObjectComparison)

Creates a report from an ObjectComparison.

public string GenerateReport(ObjectComparison source)

Parameters

Name	Type	Description
source	ObjectComparison

Returns

string

GenerateReport(IEnumerable<ObjectComparison>)

Creates a report from a collection ObjectComparisons

public string GenerateReport(IEnumerable<ObjectComparison> source)

Parameters

Name	Type	Description
source	IEnumerable<ObjectComparison>

Returns

string