C# Class SobekCM.Library.HTML.MySobek_HtmlSubwriter

My Sobek html subwriter is used for registration and authentication with mySobek, as well as performing any task which requires authentication, such as online submittal, metadata editing, and system administrative tasks
This class extends the abstractHtmlSubwriter abstract class.

During a valid html request, the following steps occur:
  • Application state is built/verified by the Application_State_Builder
  • Request is analyzed by the QueryString_Analyzer and output as a Navigation_Object
  • Main writer is created for rendering the output, in his case the Html_MainWriter
  • The HTML writer will create this necessary subwriter since this action requires authentication.
  • This class will create a mySobek subwriter (extending MySobekViewer.abstract_MySobekViewer ) for the specified task.The mySobek subwriter creates an instance of this viewer to view and edit existing item aggregationPermissions in this digital library
Inheritance: abstractHtmlSubwriter
Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method Description
Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void

Adds any necessary controls to one of two place holders on the main ASPX page
MySobek_HtmlSubwriter ( RequestCache RequestSpecificValues ) : System

Constructor for a new instance of the MySobek_HtmlSubwriter class
Write_Additional_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void

Writes additional HTML needed in the main form before the main place holder but after the other place holders.
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 my sobek html subwriter directly to the response stream
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

Method Details

Add_Controls() public method

Adds any necessary controls to one of two place holders on the main ASPX page
public Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder 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

MySobek_HtmlSubwriter() public method

Constructor for a new instance of the MySobek_HtmlSubwriter class
public MySobek_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 additional HTML needed in the main form before the main place holder but after the other place holders.
public Write_Additional_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_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 my sobek 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_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 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_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