C# Class SobekCM.Library.HTML.Internal_HtmlSubwriter

Internal html subwriter renders all of the screens about the collections and items held within this digital library, the list of items edited or recently added, and the current memory profile

This class extends the abstractHtmlSubwriter abstract class.

Inheritance: abstractHtmlSubwriter

Exibir arquivo Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method	Description
Internal_HtmlSubwriter ( RequestCache RequestSpecificValues ) : System	Constructor for a new instance of the Internal_HtmlSubwriter class
Write_Final_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes final HTML after all the forms
Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : bool	Writes the HTML generated by this internal html subwriter directly to the response stream
Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : void	Write any additional values within the HTML Head of the final served page

Protected Methods

Method	Description
Month_From_Int ( int Month_Int ) : string	Convert between the month sequence and the english month name
add_aggregations_master_list_html ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds information about all aggregationPermissions to the response stream
add_aggregations_tree_html ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds information about all aggregationPermissions to the response stream
add_build_failures ( TextWriter Output, int FirstMonth, int FirstYear, int SecondMonth, int SecondYear, Custom_Tracer Tracer ) : void	Adds the list of build failures to the output stream for a given date range
add_cache_html ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds the current memory profile to the response stream
add_new_item_html ( TextWriter Output, DataTable New_Items, Custom_Tracer Tracer ) : void	Adds the list of all new and recently changed items to the response stream
add_wordmarks ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds the wordmarks to the response stream

Private Methods

Method	Description
add_children_to_tree ( string LeadingSpaces, TextWriter Output, Item_Aggregation_Related_Aggregations Aggr ) : void

Method Details

Internal_HtmlSubwriter() public method

Constructor for a new instance of the Internal_HtmlSubwriter class

public Internal_HtmlSubwriter ( RequestCache RequestSpecificValues ) : System
RequestSpecificValues	RequestCache	All the necessary, non-global data specific to the current request
return	System

Month_From_Int() protected method

Convert between the month sequence and the english month name

protected Month_From_Int ( int Month_Int ) : string
Month_Int	int	Sequence for the month to return the string for
return	string

Write_Final_HTML() public method

Writes final HTML after all the forms

public Write_Final_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to directly write to
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Write_HTML() public method

Writes the HTML generated by this internal html subwriter directly to the response stream

public Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : bool
Output	System.IO.TextWriter	Stream to which to write the HTML for this subwriter
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Write_Within_HTML_Head() public method

Write any additional values within the HTML Head of the final served page

public Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Output stream currently within the HTML head tags
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

add_aggregations_master_list_html() protected method

Adds information about all aggregationPermissions to the response stream

protected add_aggregations_master_list_html ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this subwriter
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

add_aggregations_tree_html() protected method

Adds information about all aggregationPermissions to the response stream

protected add_aggregations_tree_html ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this subwriter
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

add_build_failures() protected method

Adds the list of build failures to the output stream for a given date range

protected add_build_failures ( TextWriter Output, int FirstMonth, int FirstYear, int SecondMonth, int SecondYear, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this subwriter
FirstMonth	int	Month for the first date in the date range
FirstYear	int	Year for the first date in the date range
SecondMonth	int	Month for the last date in the date range
SecondYear	int	Year for the last date in the date range
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

add_cache_html() protected method

Adds the current memory profile to the response stream

protected add_cache_html ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this subwriter
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

add_new_item_html() protected method

Adds the list of all new and recently changed items to the response stream

protected add_new_item_html ( TextWriter Output, DataTable New_Items, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this subwriter
New_Items	System.Data.DataTable	The list of recently added/changed items to display
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

add_wordmarks() protected method

Adds the wordmarks to the response stream

protected add_wordmarks ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this subwriter
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void