C# Class CTCClassSchedule.AutomatedFootnotesConfig

A handler class for the Automated Footnote settings in the web.config
Show file Open project: BellevueCollege/ClassSchedule

Protected Properties

Property Type Description
_footnoteInstances AutomatedFootnoteElement>.Dictionary

Public Methods

Method Description
Footnotes ( string footnoteName ) : AutomatedFootnoteElement

Returns a footnote message element based on the name.

getAutomatedFootnotesText ( Section section ) : string

Takes a Section and produces all automated messages that the section should display.

Private Methods

Method Description
AutomatedFootnotesConfig ( ) : System

Constructor. Initiates the serialization of the automated footnotes section in the web.config file.

GetFootnoteInstances ( AutomatedFootnoteCollection collection ) : AutomatedFootnoteElement>.Dictionary

Returns a dictionary of all elements within a given collection of footnote messages. The key is the name of the footnote element, the value is the element itself.

buildFootnoteText ( System.Boolean differentStartFlag, System.Boolean differentEndFlag, System.Boolean hybridFlag, System.Boolean telecourseFlag, System.DateTime startDate, System.DateTime endDate ) : string
getApplicableDateFootnote ( System.Boolean differentStartFlag, System.Boolean differentEndFlag, System.DateTime startDate, System.DateTime endDate ) : AutomatedFootnoteElement

Uses a section's start/end date to determine an applicable date footnote. By design, at most one date related footnote will be relevant to any given section. This method determines and returns the applicable footnote, should one exist.

Method Details

Footnotes() public static method

Returns a footnote message element based on the name.
public static Footnotes ( string footnoteName ) : AutomatedFootnoteElement
footnoteName string The anme of the element you want.
return AutomatedFootnoteElement

getAutomatedFootnotesText() public static method

Takes a Section and produces all automated messages that the section should display.
public static getAutomatedFootnotesText ( Section section ) : string
section Ctc.Ods.Types.Section The section to base the generated footnote messages on.
return string

Property Details

_footnoteInstances protected static property

Private dictionary that maps the name of each automated footnote message to the footnote element itself.
protected static Dictionary _footnoteInstances
return AutomatedFootnoteElement>.Dictionary