GH_HtmlFormatter

References
public class GH_HtmlFormatter

Constructors

GH_HtmlFormatter

#
public GH_HtmlFormatter()

GH_HtmlFormatter

#
public GH_HtmlFormatter(IGH_InstanceDescription nSource, string nTitle, string nDescription)
Parameters:
nSource (IGH_InstanceDescription)
nTitle (string)
nDescription (string)

GH_HtmlFormatter

#
public GH_HtmlFormatter(IGH_InstanceDescription nSource, string nTitle)
Parameters:
nSource (IGH_InstanceDescription)
nTitle (string)

GH_HtmlFormatter

#
public GH_HtmlFormatter(IGH_InstanceDescription nSource)
Parameters:
nSource (IGH_InstanceDescription)

Fields

m_description

#
protected string m_description

m_remarks

#
protected List<GH_HtmlRemark> m_remarks

m_source

#
protected IGH_InstanceDescription m_source

m_title

#
protected string m_title

Properties

ContactURI

#
public string ContactURI { get; set; }
Gets or sets the Contact URI (name@domain.com) for this html page. The Contact details are displayed beneath the Webpage URI. If Null or String.Empty, no contact details are displayed.

Description

#
public string Description { get; set; }
Gets or sets the description of this html page The description is displayed directly beneath the title

Remarks

#
public List<GH_HtmlRemark> Remarks { get; }
Gets the list of remarks. Remarks are displayed as a bullet list underneath the contact details

Title

#
public string Title { get; set; }
Gets or sets the title of this html page The title is displayed along the top of the document.

WebPageURI

#
public string WebPageURI { get; set; }
Gets or sets the Webpage URI (email address) for this html page The Webpage details are displayed beneath the Description section If Null or String.Empty, no webpage details are displayed

Methods

AddRemark

#
public void AddRemark(string text, GH_HtmlFormatterPalette forecolour = GH_HtmlFormatterPalette.Black, GH_HtmlFormatterPalette backcolour = GH_HtmlFormatterPalette.White)
Adds a remark to the list. Remarks are displayed underneath the contact details
Parameters:
text (string)The text of the remark
forecolour (GH_HtmlFormatterPalette = GH_HtmlFormatterPalette.Black)The foreground colour of the remark string
backcolour (GH_HtmlFormatterPalette = GH_HtmlFormatterPalette.White)The background colour of the remark string

HtmlFormat

#
public string HtmlFormat()
Converts all the items in this formatter into a single HTML formatted string

HtmlPaletteTag

#
public static string HtmlPaletteTag(GH_HtmlFormatterPalette palette)
Parameters:
palette (GH_HtmlFormatterPalette)

ReplaceBoxDrawingCodes

#
public static string ReplaceBoxDrawingCodes(string source)
Replaces Box Drawing chars from a string with HTML codes for those chars. Tildes are replaced with Non-Breaking spaces.
Parameters:
source (string)

ReplaceSpecialCharCodes

#
public static string ReplaceSpecialCharCodes(string source)
Replaces special chars (© ® ™ ² ³ ×) from a string with HTML codes for those chars.
Parameters:
source (string)