C# Class PurplePen.DescriptionFormatter

The description formatter takes a CourseView, and transforms it into a generic description sheet -- an array of DescriptionLine objects.

Exibir arquivo Open project: petergolde/PurplePen Class Usage Examples

Public Methods

Method	Description
ClearTextAndSymbols ( DescriptionLine lines ) : void
CreateDescription ( bool createKey ) : PurplePen.DescriptionLine[]
DescriptionFormatter ( CourseView courseView, SymbolDB symbolDB ) : System
DumpDescription ( SymbolDB symbolDB, DescriptionLine lines, TextWriter writer ) : void

Private Methods

Method	Description
AddTextLine ( List list, string text, Id courseControlId, Id controlId, DescriptionLine textLineKind ) : void
DumpDescriptionLine ( SymbolDB symbolDB, DescriptionLine line, TextWriter writer ) : void
FilterControl ( CourseView kind, ControlPoint control, ControlPoint controlPrev, ControlPoint controlNext ) : bool
FilterLeg ( CourseView kind, ControlPoint from, ControlPoint to, Leg leg ) : bool
GetAllControlsHeaderLine ( ) : DescriptionLine
GetAllVariationsHeaderLine ( ) : DescriptionLine
GetDirectiveLine ( CourseView kind, CourseView controlView, CourseView controlViewPrev ) : DescriptionLine
GetMapExchangeAtControlLine ( CourseView controlWithExchange ) : DescriptionLine
GetMapExchangeLine ( CourseView controlViewFrom, CourseView controlViewTo ) : DescriptionLine
GetMarkedRouteLine ( CourseView controlViewFrom, CourseView controlViewTo, Id legId ) : DescriptionLine
GetNormalHeaderLine ( ) : DescriptionLine
GetRegularLine ( CourseView kind, int scoreColumn, CourseView controlView, string>.Dictionary descriptionKey ) : DescriptionLine
GetScoreHeaderLine ( ) : DescriptionLine
GetTextLineFromText ( string text, Id courseControlId, Id controlId, DescriptionLine textLineKind ) : PurplePen.DescriptionLine[]
GetTitleLine1 ( ) : string
GetTitleLine2 ( ) : string
GetTitleLineFromText ( DescriptionLineKind kind, string text ) : PurplePen.DescriptionLine[]

Method Details

ClearTextAndSymbols() public static method

public static ClearTextAndSymbols ( DescriptionLine lines ) : void
lines	DescriptionLine
return	void

CreateDescription() public method

public CreateDescription ( bool createKey ) : PurplePen.DescriptionLine[]
createKey	bool
return	PurplePen.DescriptionLine[]

DescriptionFormatter() public method

public DescriptionFormatter ( CourseView courseView, SymbolDB symbolDB ) : System
courseView	CourseView
symbolDB	SymbolDB
return	System

DumpDescription() public static method

public static DumpDescription ( SymbolDB symbolDB, DescriptionLine lines, TextWriter writer ) : void
symbolDB	SymbolDB
lines	DescriptionLine
writer	System.IO.TextWriter
return	void