C# Class SobekCM.Library.HTML.Item_HtmlSubwriter

Item html subwriter renders views on a single digital resource

This class extends the abstractHtmlSubwriter abstract class.

Inheritance: abstractHtmlSubwriter

Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property	Type	Description
treeView1_SelectedNodeChanged	void

Public Methods

Method	Description
Add_Header ( TextWriter Output ) : void	Add the header to the output
Add_Main_Viewer_Section ( System.Web.UI.WebControls.PlaceHolder Main_PlaceHolder, Custom_Tracer Tracer ) : void	Performs the final HTML writing which completes the item table and adds the final page navigation buttons at the bottom of the page
Add_Standard_TOC ( System.Web.UI.WebControls.PlaceHolder TocPlaceHolder, Custom_Tracer Tracer ) : void	Adds the table of contents as a control in the left navigation bar
Create_TreeView_From_Divisions ( TreeView TreeViewArg ) : void	Populates the tree view with the divisions from the current digital resource item
Item_HtmlSubwriter ( RequestCache RequestSpecificValues ) : System	Constructor for a new instance of the Item_HtmlSubwriter class
Write_Additional_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes the HTML generated by this item html subwriter directly to the response stream This continues writing this item from finishing the left navigation bar to the popup forms to the page navigation controls at the top of the item viewer's main area
Write_Final_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Spot to write any final HTML to the response stream
Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : bool	Writes the HTML generated by this item html subwriter directly to the response stream This begins writing this page, up to the item-level main menu
Write_Internal_Header_HTML ( TextWriter Output, User_Object Current_User ) : void	Adds the internal header HTML for this specific HTML writer
Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes final HTML to the output stream after all the placeholders and just before the itemNavForm is closed.
Write_ItemNavForm_Opening ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes the html to the output stream open the itemNavForm, which appears just before the TocPlaceHolder
Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : void	Write any additional values within the HTML Head of the final served page

Private Methods

Method	Description
treeView1_SelectedNodeChanged ( object Sender, EventArgs E ) : void	Event is fired if the currently selected tree view node changes.

Method Details

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_Main_Viewer_Section() public method

Performs the final HTML writing which completes the item table and adds the final page navigation buttons at the bottom of the page

public Add_Main_Viewer_Section ( System.Web.UI.WebControls.PlaceHolder Main_PlaceHolder, Custom_Tracer Tracer ) : void
Main_PlaceHolder	System.Web.UI.WebControls.PlaceHolder	Main place holder ( "mainPlaceHolder" ) in the itemNavForm form, widely used throughout the application
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Add_Standard_TOC() public method

Adds the table of contents as a control in the left navigation bar

public Add_Standard_TOC ( System.Web.UI.WebControls.PlaceHolder TocPlaceHolder, Custom_Tracer Tracer ) : void
TocPlaceHolder	System.Web.UI.WebControls.PlaceHolder	TOC place holder ( "tocPlaceHolder" ) in the itemNavForm form, widely used throughout the application
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Create_TreeView_From_Divisions() public method

Populates the tree view with the divisions from the current digital resource item

public Create_TreeView_From_Divisions ( TreeView TreeViewArg ) : void
TreeViewArg	System.Web.UI.WebControls.TreeView	Tree view control to populate
return	void

Item_HtmlSubwriter() public method

Constructor for a new instance of the Item_HtmlSubwriter class

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

Write_Additional_HTML() public method

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

This continues writing this item from finishing the left navigation bar to the popup forms to the page navigation controls at the top of the item viewer's main area

public Write_Additional_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

Write_Final_HTML() public method

Spot to write any final HTML to the response stream

public Write_Final_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

Write_HTML() public method

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

This begins writing this page, up to the item-level main menu

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_Internal_Header_HTML() public method

Adds the internal header HTML for this specific HTML writer

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

Write_ItemNavForm_Closing() public method

Writes final HTML to the output stream after all the placeholders and just before the itemNavForm is closed.

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

Write_ItemNavForm_Opening() public method

Writes the html to the output stream open the itemNavForm, which appears just before the TocPlaceHolder

public Write_ItemNavForm_Opening ( 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_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