Click or drag to resize

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.

Inheritance Hierarchy

Namespace:  DHI.Mike1D.Generic
Assembly:  DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class HTMLLog

The HTMLLog type exposes the following members.

Constructors
  NameDescription
Public methodHTMLLog
Initializes a new instance of the HTMLLog class
Top
Properties
  NameDescription
Public propertyCssStyle
CSS style
Public propertyFilePath
The file path of the html file.
Public propertyMaxNumberOfFileBackups
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.
Public propertySections
Sections in HTML file
Public propertyUnitProvider
Unit provider, for unit conversions
Top
Methods
  NameDescription
Public methodAddIndexSection
Add index-section to HTML Sections. After adding all other sections, you also need to call BuildIndex(HtmlContentSection).
Public methodBuildIndex
Build an index in the indexHtmlItem. The index is based on all sections with a name defined.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFormatDateTime
Format a DateTime object as string

if time is

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

Public methodFormatPercent
Format a % value to string

if value is

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

Public methodFormatRatio
Format a ratio or fraction value to string

if value is

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

Public methodFormatTimeSpan
Format a TimeSpan object as string
Public methodFormatValue
Perform unit conversion and format a value to string.

if value is

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

Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRollLogFile
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)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWrite
Write log to disk
Protected methodWriteFooter
Write HTML Footer
Protected methodWriteHeader
Write HTML header
Protected methodWriteHTMLContent
Protected methodWriteIndexLink
Write an index-link - link to a section. Must match WriteSectionBegin(TextWriter, String)
Public methodWriteItemBegin
Write start of item in section
Protected methodWriteSectionBegin
Write start of section
Protected methodWriteSections
Write all sections to w
Top
See Also