Rotating_Highlight_Search_AggregationViewer Class

Renders the basic search / home page for a given item aggregation

Namespace: SobekCM.Library.AggregationViewer.Viewers
Assembly: SobekCM_Library (in SobekCM_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public class Rotating_Highlight_Search_AggregationViewer : abstractAggregationViewer

Remarks

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

Collection viewers are used when displaying collection home pages, searches, browses, and information pages.

During a valid html request to display the home page with basic 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

Inheritance Hierarchy

System..::..Object
SobekCM.Library.AggregationViewer.Viewers..::..abstractAggregationViewer
SobekCM.Library.AggregationViewer.Viewers..::..Rotating_Highlight_Search_AggregationViewer

Constructors

	Name	Description
	Rotating_Highlight_Search_AggregationViewer	Constructor for a new instance of the Rotating_Highlight_Search_AggregationViewer class

Methods

	Name	Description
	Add_Search_Box_HTML	Add the HTML to be displayed in the search box (Overrides abstractAggregationViewer..::..Add_Search_Box_HTML(TextWriter, Custom_Tracer).)
	Add_Secondary_Controls	Add the HTML and controls to the section below the search box (Inherited from abstractAggregationViewer.)
	Add_Secondary_HTML	Add the HTML to be displayed below the search box (Inherited from abstractAggregationViewer.)
	Add_Simple_Search_Tips	Writes the simple search tips out to the HTTP text writer (Inherited from abstractAggregationViewer.)

Fields

	Name	Description
	RequestSpecificValues	Protected field contains the information specific to the current request (Inherited from abstractAggregationViewer.)
	ViewBag	Protected field contains the aggregation-specific request information (Inherited from abstractAggregationViewer.)

Properties

	Name	Description
	AggregationViewer_Behaviors	Gets the collection of special behaviors which this aggregation viewer requests from the main HTML subwriter. (Overrides abstractAggregationViewer..::..AggregationViewer_Behaviors.)
	Is_Internal_View	Gets flag which indicates whether this is an internal view, which may have a slightly different design feel (Inherited from abstractAggregationViewer.)
	Search_Script_Action	Reference to the javascript method to be called (Inherited from abstractAggregationViewer.)
	Search_Script_Reference	Reference to the javascript used to initiate the search (Inherited from abstractAggregationViewer.)
	Secondary_Text_Requires_Controls	Flag indicates whether the secondary text requires controls (Inherited from abstractAggregationViewer.)
	Selection_Panel_Display	Flag indicates whether the subaggregation selection panel is displayed for this collection viewer (Overrides abstractAggregationViewer..::..Selection_Panel_Display.)
	Sharing_Buttons_HTML	Sets the sharing buttons HTML to display over the banner
	Type	Gets the type of collection view or search supported by this collection viewer (Overrides abstractAggregationViewer..::..Type.)
	Viewer_Icon	Gets the URL for the icon related to this aggregational viewer task (Inherited from abstractAggregationViewer.)
	Viewer_Title	Title for the page that displays this viewer, this is shown in the search box at the top of the page, just below the banner (Inherited from abstractAggregationViewer.)