C# Class SobekCM.Library.HTML.Search_Results_HtmlSubwriter

Search results html subwriter renders a browse of search results
This class extends the abstractHtmlSubwriter abstract class.
Inheritance: abstractHtmlSubwriter
ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

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

Adds controls to the main navigational page

This uses a PagedResults_HtmlSubwriter instance to render the items

Add_Footer ( TextWriter Output ) : void

Add the footer to the output

Add_Header ( TextWriter Output ) : void

Add the header to the output

Search_Results_HtmlSubwriter ( RequestCache RequestSpecificValues ) : System

Constructor for a new instance of the Search_Results_HtmlSubwriter class

Write_Final_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void

Writes the final output to close this search page results, including the results page navigation buttons

This calls the PagedResults_HtmlSubwriter.Write_Final_HTML method in the PagedResults_HtmlSubwriter object.

Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : bool

Writes the HTML generated to browse the results of a search 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

Method Details

Add_Controls() public method

Adds controls to the main navigational page
This uses a PagedResults_HtmlSubwriter instance to render the items
public Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer, TreeNodeEventHandler PopulateNodeEvent ) : void
MainPlaceHolder System.Web.UI.WebControls.PlaceHolder Main place holder ( "mainPlaceHolder" ) in the itemNavForm form, widely used throughout the application
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
PopulateNodeEvent TreeNodeEventHandler Event is used to populate the a tree node without doing a full refresh of the page
return void

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

Search_Results_HtmlSubwriter() public method

Constructor for a new instance of the Search_Results_HtmlSubwriter class
public Search_Results_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 the final output to close this search page results, including the results page navigation buttons
This calls the PagedResults_HtmlSubwriter.Write_Final_HTML method in the PagedResults_HtmlSubwriter object.
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 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 to browse the results of a search 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_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 Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void