C# Class SobekCM.Library.HTML.PagedResults_HtmlSubwriter

Accepts a result set of titles and items and renders the correct page of results in the result view the user has requested
This class extends the abstractHtmlSubwriter abstract class.
Inheritance: abstractHtmlSubwriter
Afficher le fichier Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Méthodes publiques

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

Adds controls to the main navigational page

PagedResults_HtmlSubwriter ( RequestCache RequestSpecificValues, SobekCM.Core.Results.Search_Results_Statistics ResultsStats, List PagedResults ) : System

Constructor for a new instance of the paged_result_html_subwriter class

Write_Final_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void

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

Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : bool

Writes the HTML generated to browse the list of titles/itemsr directly to the response stream

Méthodes protégées

Méthode Description
Add_Facet_Information ( Custom_Tracer Tracer ) : string

Returns the facets for this result/browse as HTML to be added into the form

Show_Search_Info ( TextWriter Output, bool IncludeResultCount ) : void

Renders the text about this search (i.e., "Your search for ... resulted in ..." ) directly to the output stream

Private Methods

Méthode Description
Add_Single_Facet ( StringBuilder Builder, string Title, string SearchCode, string ShowLess, string ShowMore, int FacetIndex, string SortByFrequency, string SortAlphabetically, List Collection ) : void
Add_Single_Facet_Callback ( StringBuilder Builder, string Title, string SearchCode, string ShowLess, string ShowMore, int FacetIndex, string SortByFrequency, string SortAlphabetically, List Collection ) : void
Search_Label_from_Sobek_Code ( string Code ) : string
create_resultwriter ( ) : void

Creates the specific results viewer according the user's preferences in the current request mode

remove_html_tags ( string MixedHtmlText ) : string

Method Details

Add_Controls() public méthode

Adds controls to the main navigational 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
Résultat void

Add_Facet_Information() protected méthode

Returns the facets for this result/browse as HTML to be added into the form
protected Add_Facet_Information ( Custom_Tracer Tracer ) : string
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
Résultat string

PagedResults_HtmlSubwriter() public méthode

Constructor for a new instance of the paged_result_html_subwriter class
public PagedResults_HtmlSubwriter ( RequestCache RequestSpecificValues, SobekCM.Core.Results.Search_Results_Statistics ResultsStats, List PagedResults ) : System
RequestSpecificValues RequestCache All the necessary, non-global data specific to the current request
ResultsStats SobekCM.Core.Results.Search_Results_Statistics Statistics about the results to display including the facets
PagedResults List Actual pages of results
Résultat System

Show_Search_Info() protected méthode

Renders the text about this search (i.e., "Your search for ... resulted in ..." ) directly to the output stream
protected Show_Search_Info ( TextWriter Output, bool IncludeResultCount ) : void
Output System.IO.TextWriter Stream to which to write the HTML for this subwriter
IncludeResultCount bool Flag tells whether to include the number of results in the text
Résultat void

Write_Final_HTML() public méthode

Writes the final output to close this result view, including the results page navigation buttons
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
Résultat void

Write_HTML() public méthode

Writes the HTML generated to browse the list of titles/itemsr 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
Résultat bool