mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='http://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='http://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='http://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='http://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='http://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
Expand <a href='http://sobekrepository.org/codehelp/engineagnosticlayerdbaccess' title='EngineAgnosticLayerDbAccess'>EngineAgnosticLayerDbAccess Namespace</a>EngineAgnosticLayerDbAccess Namespace
Expand <a href='http://sobekrepository.org/codehelp/builder_library' title='SobekCM.Builder_Library'>Builder_Library Namespace</a>Builder_Library Namespace
Expand <a href='http://sobekrepository.org/codehelp/core' title='SobekCM.Core'>Core Namespace</a>Core Namespace
Expand <a href='http://sobekrepository.org/codehelp/engine_library' title='SobekCM.Engine_Library'>Engine_Library Namespace</a>Engine_Library Namespace
Collapse <a href='http://sobekrepository.org/codehelp/library' title='SobekCM.Library'>Library Namespace</a>Library Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/adminviewer' title='SobekCM.Library.AdminViewer'>AdminViewer Sub-Namespace</a>AdminViewer Sub-Namespace
Collapse <a href='http://sobekrepository.org/codehelp/library/aggregationviewer' title='SobekCM.Library.AggregationViewer'>AggregationViewer Sub-Namespace</a>AggregationViewer Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/ckeditor' title='SobekCM.Library.CKEditor'>CKEditor Sub-Namespace</a>CKEditor Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/citation' title='SobekCM.Library.Citation'>Citation Sub-Namespace</a>Citation Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/database' title='SobekCM.Library.Database'>Database Sub-Namespace</a>Database Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/email' title='SobekCM.Library.Email'>Email Sub-Namespace</a>Email Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/html' title='SobekCM.Library.HTML'>HTML Sub-Namespace</a>HTML Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/itemviewer' title='SobekCM.Library.ItemViewer'>ItemViewer Sub-Namespace</a>ItemViewer Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/localization' title='SobekCM.Library.Localization'>Localization Sub-Namespace</a>Localization Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/mainwriters' title='SobekCM.Library.MainWriters'>MainWriters Sub-Namespace</a>MainWriters Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/mysobekviewer' title='SobekCM.Library.MySobekViewer'>MySobekViewer Sub-Namespace</a>MySobekViewer Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/resultsviewer' title='SobekCM.Library.ResultsViewer'>ResultsViewer Sub-Namespace</a>ResultsViewer Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/ui' title='SobekCM.Library.UI'>UI Sub-Namespace</a>UI Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/uploadifive' title='SobekCM.Library.UploadiFive'>UploadiFive Sub-Namespace</a>UploadiFive Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/webcontentviewer' title='SobekCM.Library.WebContentViewer'>WebContentViewer Sub-Namespace</a>WebContentViewer Sub-Namespace
Expand <a href='http://sobekrepository.org/codehelp/library/aggregationviewbag' title='AggregationViewBag Class'>AggregationViewBag</a>AggregationViewBag
Expand <a href='http://sobekrepository.org/codehelp/library/requestcache' title='RequestCache Class'>RequestCache</a>RequestCache
Expand <a href='http://sobekrepository.org/codehelp/library/resource_web_config_writer' title='Resource_Web_Config_Writer Class'>Resource_Web_Config_Writer</a>Resource_Web_Config_Writer
Expand <a href='http://sobekrepository.org/codehelp/library/sobekcm_assistant' title='SobekCM_Assistant Class'>SobekCM_Assistant</a>SobekCM_Assistant
Expand <a href='http://sobekrepository.org/codehelp/library/static_pages_builder' title='Static_Pages_Builder Class'>Static_Pages_Builder</a>Static_Pages_Builder
Expand <a href='http://sobekrepository.org/codehelp/library/text_search_term_highlighter' title='Text_Search_Term_Highlighter Class'>Text_Search_Term_Highlighter</a>Text_Search_Term_Highlighter
Expand <a href='http://sobekrepository.org/codehelp/resource_object' title='SobekCM.Resource_Object'>Resource_Object Namespace</a>Resource_Object Namespace
Expand <a href='http://sobekrepository.org/codehelp/tools' title='SobekCM.Tools'>Tools Namespace</a>Tools Namespace
MISSING BANNER
Code Details >> Library >> AggregationViewer >> Viewers >> iAggregationViewer Interface

iAggregationViewer Interface



Interface which all collection viewers must implement


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

Syntax

C#
public interface iAggregationViewer

Remarks

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 )

Methods

  NameDescription
Public methodAdd_Search_Box_HTML
Add the HTML to be displayed in the search box
Public methodAdd_Secondary_Controls
Add the HTML and controls to the section below the search box
Public methodAdd_Secondary_HTML
Add the HTML to be displayed below the search box

Properties

  NameDescription
Public propertyAggregationViewer_Behaviors
Gets the collection of special behaviors which this aggregation viewer requests from the main HTML subwriter.
Public propertyIs_Internal_View
Gets flag which indicates whether this is an internal view, which may have a slightly different design feel
Public propertySearch_Script_Action
Gets the reference to the javascript method to be called
Public propertySearch_Script_Reference
Gets the reference to the javascript file to be included in the HTML
Public propertySecondary_Text_Requires_Controls
Gets flag which indicates whether the secondary text requires controls
Public propertySelection_Panel_Display
Gets flag which indicates whether the selection panel should be displayed
Public propertyType
Gets the type of collection view or search
Public propertyViewer_Icon
Gets the URL for the icon related to this aggregational viewer task
Public propertyViewer_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

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )