Table of Contents

Class RecordBase

Namespace
CodeStage.Maintainer
Assembly
Build.dll

Base class for all record-based modules results items.

[Serializable]
public abstract class RecordBase
Inheritance
object
RecordBase
Derived

Constructors

RecordBase(LocationGroup) 

protected RecordBase(LocationGroup locationGroup)

Parameters

locationGroup LocationGroup

Fields

cachedBody 

protected StringBuilder cachedBody

Field Value

StringBuilder

cachedCompactLine 

protected StringBuilder cachedCompactLine

Field Value

StringBuilder

cachedHeader 

protected StringBuilder cachedHeader

Field Value

StringBuilder

Properties

BodyPostfix 

public string BodyPostfix { get; set; }

Property Value

string

HeaderPostfix 

public string HeaderPostfix { get; set; }

Property Value

string

LocationGroup

LocationGroup of the item.

public LocationGroup LocationGroup { get; }

Property Value

LocationGroup

Methods

ConstructBody(StringBuilder) 

protected abstract void ConstructBody(StringBuilder text)

Parameters

text StringBuilder

ConstructCompactLine(StringBuilder) 

protected abstract void ConstructCompactLine(StringBuilder text)

Parameters

text StringBuilder

ConstructHeader(StringBuilder) 

protected abstract void ConstructHeader(StringBuilder text)

Parameters

text StringBuilder

GetBody()

Gets item body, may be multiline.

public string GetBody()

Returns

string

Full item body.

GetCompactLine()

Gets item label in a single line compact form.

public string GetCompactLine()

Returns

string

Compacted item label.

GetHeader()

Gets item header.

public string GetHeader()

Returns

string

Full header of the item, includes RichText tags..

ToString()

Gets full multiline item description constructed from header and body.

public override string ToString()

Returns

string

Full item description.

ToString(bool)

Same as parameterless version but clears RichText (html) tags out.

public string ToString(bool clearHtml)

Parameters

clearHtml bool

Clears all RichText (html) tags when true, and leaves them untouched otherwise.

Returns

string

Full item description without RichText (html) tags.