C# Class SobekCM.Library.AggregationViewer.Viewers.DataSet_Browse_Info_AggregationViewer

Renders the item list matching a browse or search against an item aggregation

This class implements the iAggregationViewer interface and extends the abstractAggregationViewer class.

Aggregation viewers are used when displaying aggregation home pages, searches, browses, and information pages.

During a valid html request to display items matching a browse or search, 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 this case the Html_MainWriter
The HTML writer will create the necessary subwriter. For a collection-level request, an instance of the Aggregation_HtmlSubwriter class is created.
To display the requested collection view, the collection subwriter will creates an instance of this class
To display the actual results, this class will create an instance of the PagedResults_HtmlSubwriter class
That subwriter creates its own results viewer which extends the ResultsViewer.abstract_ResultsViewer class

Inheritance: abstractAggregationViewer

ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method	Description
Add_Search_Box_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Add the HTML to be displayed in the search box
Add_Secondary_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void	Add controls to the placeholder below the search box This adds the results from the dataset into the space below the search box. This creates and uses a PagedResults_HtmlSubwriter to write the results.
DataSet_Browse_Info_AggregationViewer ( RequestCache RequestSpecificValues, AggregationViewBag ViewBag ) : System.Collections.Generic	Constructor for a new instance of the DataSet_Browse_Info_AggregationViewer class

Method Details

Add_Search_Box_HTML() public method

Add the HTML to be displayed in the search box

public Add_Search_Box_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Textwriter to write the HTML for this viewer
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Add_Secondary_Controls() public method

Add controls to the placeholder below the search box

This adds the results from the dataset into the space below the search box.

This creates and uses a PagedResults_HtmlSubwriter to write the results.

public Add_Secondary_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder	System.Web.UI.WebControls.PlaceHolder	Placeholder into which to place controls to be rendered
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

DataSet_Browse_Info_AggregationViewer() public method

Constructor for a new instance of the DataSet_Browse_Info_AggregationViewer class

public DataSet_Browse_Info_AggregationViewer ( RequestCache RequestSpecificValues, AggregationViewBag ViewBag ) : System.Collections.Generic
RequestSpecificValues	RequestCache	All the necessary, non-global data specific to the current request
ViewBag	AggregationViewBag	Aggregation-specific request information, such as aggregation object and any browse object requested
return	System.Collections.Generic