Report

Namespace: Babel.Licensing Assembly: Babel.Licensing.dll

Represents the base class for any report object.

public class Report

Inheritance

object ← Report

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

Report(string)

Initializes a new report instance with a given name.

public Report(string name)

Parameters

Name	Description
name string	The name.

Report(string, string)

Initializes a new report instance with a given report name and content.

public Report(string name, string content)

Parameters

Name	Description
name string	The report name.
content string	The report content.

Exceptions

Name	Description
ArgumentNullException	Thrown when one or more required arguments are null.

Fields

FormatVersion

Current Report version.

public static readonly string FormatVersion

Field Value

string

Properties

Content

Gets the report content.

public virtual string Content { get; }

Property Value

string

Date

Gets or sets the report date.

public virtual DateTime? Date { get; set; }

Property Value

DateTime?

Encrypted

Gets a value indicating whether the report content is encrypted.

public virtual bool Encrypted { get; }

Property Value

bool

Name

Gets the report name.

public virtual string Name { get; }

Property Value

string

Properties

Gets the report properties.

public Dictionary<string, object> Properties { get; }

Property Value

Dictionary<string, object>

Version

Gets the report version.

public virtual string Version { get; }

Property Value

string

Methods

Build()

Builds this object.

public virtual void Build()

Create(string, string)

Creates a report from its string content.

public static Report Create(string report, string password = null)

Parameters

Name	Description
report string	The report content.
password string	(Optional) The password to decrypt report content.

Returns

Name	Description
Report	A Report object.

Exceptions

Name	Description
ArgumentNullException	Thrown when one or more required arguments are null.
ArgumentException	Thrown when one or more arguments have unsupported or illegal values.
InvalidOperationException	Thrown when the requested operation is invalid.