C# Class SobekCM.Library.HTML.Aggregation_HtmlSubwriter

Aggregation html subwriter renders all views of item aggregations, including home pages, searches, and browses

This class extends the abstractHtmlSubwriter abstract class.

Inheritance: abstractHtmlSubwriter

Mostrar archivo Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method	Description
Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : bool	Adds the tree view control to the provided place holder if this is the tree view main home page
Add_Footer ( TextWriter Output ) : void	Add the footer to the output
Add_Header ( TextWriter Output ) : void	Add the header to the output
Add_SubCollection_Buttons ( TextWriter Output, RequestCache RequestSpecificValues, SobekCM.Library.Aggregations.Item_Aggregation hierarchyObject ) : bool
Aggregation_HtmlSubwriter ( RequestCache RequestSpecificValues ) : System	Constructor creates a new instance of the Aggregation_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 aggregation html subwriter directly to the response stream
Write_Internal_Header_HTML ( TextWriter Output, SobekCM.Library.Users.User_Object Current_User ) : void	Adds the internal header HTML for this specific HTML writer
Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : void	Write any additional values within the HTML Head of the final served page By default this does nothing, but can be overwritten by all the individual html subwriters

Protected Methods

Method	Description
add_home_html ( TextWriter Output, Custom_Tracer Tracer ) : bool	Adds the home page text to the output for this collection view
write_description_home ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds the main library home page with short descriptions about each highlighted item aggregation
write_institution_icons ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds the partner institution page from the main library home page as large icons
write_institution_list ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds the partner institution page from the main library home page as small icons and html names
write_list_home ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds the main library home page with icons and names about each highlighted item aggregation
write_personalized_home ( TextWriter Output, Custom_Tracer Tracer ) : void	Adds the personalized main library home page for logged on users
write_treeview ( TextWriter Output, Custom_Tracer Tracer ) : void	Write the treeview to the specified output

Private Methods

Method	Description
Add_Sharing_Buttons ( TextWriter Output, string FormName, string Style ) : void
Highlight_To_Html ( SobekCM.Library.Aggregations.Item_Aggregation_Highlights Highlight, string Directory ) : string
Int_To_Comma_String ( int Value ) : string
add_children_to_tree ( string LeadingSpaces, TextWriter Output, Item_Aggregation_Related_Aggregations Aggr ) : void

Method Details

Add_Controls() public method

Adds the tree view control to the provided place holder if this is the tree view main home page

public Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : bool
MainPlaceHolder	System.Web.UI.WebControls.PlaceHolder	Place holder into which to place the built tree control
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Add_Footer() public method

Add the footer to the output

public Add_Footer ( TextWriter Output ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this footer
return	void

Add_Header() public method

Add the header to the output

public Add_Header ( TextWriter Output ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this header
return	void

Add_SubCollection_Buttons() public static method

public static Add_SubCollection_Buttons ( TextWriter Output, RequestCache RequestSpecificValues, SobekCM.Library.Aggregations.Item_Aggregation hierarchyObject ) : bool
Output	System.IO.TextWriter
RequestSpecificValues	RequestCache
hierarchyObject	SobekCM.Library.Aggregations.Item_Aggregation
return	bool

Aggregation_HtmlSubwriter() public method

Constructor creates a new instance of the Aggregation_HtmlSubwriter class

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

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	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 aggregation 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	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Write_Internal_Header_HTML() public method

Adds the internal header HTML for this specific HTML writer

public Write_Internal_Header_HTML ( TextWriter Output, SobekCM.Library.Users.User_Object Current_User ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for the internal header information
Current_User	SobekCM.Library.Users.User_Object	Currently logged on user, to determine specific rights
return	void

Write_Within_HTML_Head() public method

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

By default this does nothing, but can be overwritten by all the individual html subwriters

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

add_home_html() protected method

Adds the home page text to the output for this collection view

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

write_description_home() protected method

Adds the main library home page with short descriptions about each highlighted item aggregation

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

write_institution_icons() protected method

Adds the partner institution page from the main library home page as large icons

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

write_institution_list() protected method

Adds the partner institution page from the main library home page as small icons and html names

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

write_list_home() protected method

Adds the main library home page with icons and names about each highlighted item aggregation

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

write_personalized_home() protected method

Adds the personalized main library home page for logged on users

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

write_treeview() protected method

Write the treeview to the specified output

protected write_treeview ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to the HTML response output
Tracer	Custom_Tracer	The tracer.
return	void