HTMLLog Class

Base class for HTML file writers.

The HTML file contains a number of Sections, and each section contains a number of Items.

It is handling log file rolling, i.e. when a new mysim.html log file is created, the existing is renamed to mysim01.html, and the mysim01.html is renamed to mysim02.html etc. up til MaxNumberOfFileBackups.

Definition

Namespace: DHI.Mike1D.Generic
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class HTMLLog
Inheritance
Object    HTMLLog
Derived

Constructors

HTMLLogInitializes a new instance of the HTMLLog class

Properties

CssStyle CSS style
FilePath The file path of the html file.
MaxNumberOfFileBackups Number of backups of the error log. If a *name*.html log file exists, then it is backed up with a *name*01.html ending. If *name*01.html exists, then it is moved to *name*02.html etc. MaxNumberOfErrorLogFileBackups is the last number of the backed up files. The last backed up file is deleted. The default value is 10.
Sections Sections in HTML file
UnitProvider Unit provider, for unit conversions

Methods

AddIndexSection Add index-section to HTML Sections. After adding all other sections, you also need to call BuildIndex(HtmlContentSection).
BuildIndex Build an index in the indexHtmlItem. The index is based on all sections with a name defined.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FormatDateTime Format a DateTime object as string

if time is DateTime.MinValue or DateTime.MaxValue, "-" is returned

FormatPercent Format a % value to string

if value is Double.MinValue or Double.MaxValue, "-" is returned

FormatRatio Format a ratio or fraction value to string

if value is Double.MinValue or Double.MaxValue, "-" is returned

FormatTimeSpan Format a TimeSpan object as string
FormatValue Perform unit conversion and format a value to string.

if value is Double.MinValue or Double.MaxValue, "-" is returned

GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
RollLogFile Rename an existing log file with name NAME.html to NAME001.html and NAME001.html to NAME002.html etc. If _maxNumberOfErrorLogFileBackups == 0 then this does nothing (no backups are created)
ToStringReturns a string that represents the current object.
(Inherited from Object)
Write Write log to disk
WriteFooter Write HTML Footer
WriteHeader Write HTML header
WriteHTMLContent Write HTML content, calling WriteHeader(TextWriter, String, String), WriteSections(TextWriter) and WriteFooter(TextWriter).
WriteIndexLink Write an index-link - link to a section. Must match WriteSectionBegin(TextWriter, String)
WriteItemBegin Write start of item in section
WriteSectionBegin Write start of section
WriteSections Write all sections to w

See Also