abstractAggregationViewer Class

Abstract class which all collection viewer classes extend

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

Syntax

C#
public abstract class abstractAggregationViewer : iAggregationViewer

Remarks

This class implements the iAggregationViewer interface.

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

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 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 create one or more collection viewers ( implementing this class )

Inheritance Hierarchy

Constructors

	Name	Description
	abstractAggregationViewer	Constructor for objects which implement this abstract class

Methods

	Name	Description
	Add_Search_Box_HTML	Add the HTML to be displayed in the search box
	Add_Secondary_Controls	Add the HTML and controls to the section below the search box
	Add_Secondary_HTML	Add the HTML to be displayed below the search box
	Add_Simple_Search_Tips	Writes the simple search tips out to the HTTP text writer

Fields

	Name	Description
	emptybehaviors	Empty list of behaviors, returned by default
	RequestSpecificValues	Protected field contains the information specific to the current request
	ViewBag	Protected field contains the aggregation-specific request information

Properties

	Name	Description
	AggregationViewer_Behaviors	Gets the collection of special behaviors which this aggregation viewer requests from the main HTML subwriter.
	Is_Internal_View	Gets flag which indicates whether this is an internal view, which may have a slightly different design feel
	Search_Script_Action	Reference to the javascript method to be called
	Search_Script_Reference	Reference to the javascript used to initiate the search
	Secondary_Text_Requires_Controls	Flag indicates whether the secondary text requires controls
	Selection_Panel_Display	Flag which indicates whether the selection panel should be displayed
	Type	Gets the type of collection view or search supported by this collection viewer
	Viewer_Icon	Gets the URL for the icon related to this aggregational viewer task
	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