Aggregation_HtmlSubwriter Class

Aggregation html subwriter renders all views of item aggregationPermissions, including home pages, searches, and browses

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

Syntax

C#
public class Aggregation_HtmlSubwriter : abstractHtmlSubwriter

Remarks

This class extends the abstractHtmlSubwriter abstract class.

Inheritance Hierarchy

System..::..Object
SobekCM.Library.HTML..::..abstractHtmlSubwriter
SobekCM.Library.HTML..::..Aggregation_HtmlSubwriter

Constructors

	Name	Description
	Aggregation_HtmlSubwriter	Constructor creates a new instance of the Aggregation_HtmlSubwriter class

Methods

	Name	Description
	Add_Controls	Adds the tree view control to the provided place holder if this is the tree view main home page
	Add_Footer	Add the footer to the output (Overrides abstractHtmlSubwriter..::..Add_Footer(TextWriter).)
	Add_Header	Add the header to the output (Overrides abstractHtmlSubwriter..::..Add_Header(TextWriter).)
	add_home_html	Adds the home page text to the output for this collection view
	Write_Additional_HTML	Writes additional HTML to the output stream just before the main place holder but after the TocPlaceHolder in the itemNavForm form. (Inherited from abstractHtmlSubwriter.)
	write_description_home	Adds the main library home page with short descriptions about each highlighted item aggregation
	Write_Final_HTML	Writes final HTML after all the forms (Overrides abstractHtmlSubwriter..::..Write_Final_HTML(TextWriter, Custom_Tracer).)
	Write_HTML	Writes the HTML generated by this aggregation html subwriter directly to the response stream (Overrides abstractHtmlSubwriter..::..Write_HTML(TextWriter, Custom_Tracer).)
	write_institution_icons	Adds the partner institution page from the main library home page as large icons
	write_institution_list	Adds the partner institution page from the main library home page as small icons and html names
	Write_Internal_Header_HTML	Adds the internal header HTML for this specific HTML writer (Overrides abstractHtmlSubwriter..::..Write_Internal_Header_HTML(TextWriter, User_Object).)
	Write_Internal_Header_Search_Box	Adds the internal header search box to the current output stream (Inherited from abstractHtmlSubwriter.)
	Write_ItemNavForm_Closing	Writes final HTML to the output stream after all the placeholders and just before the itemNavForm is closed. (Inherited from abstractHtmlSubwriter.)
	Write_ItemNavForm_Opening	Writes the html to the output stream open the itemNavForm, which appears just before the TocPlaceHolder (Inherited from abstractHtmlSubwriter.)
	write_list_home	Adds the main library home page with icons and names about each highlighted item aggregation
	write_personalized_home	Adds the personalized main library home page for logged on users
	write_treeview	Write the treeview to the specified output
	Write_Within_HTML_Head	Write any additional values within the HTML Head of the final served page (Overrides abstractHtmlSubwriter..::..Write_Within_HTML_Head(TextWriter, Custom_Tracer).)

Fields

	Name	Description
	RequestSpecificValues	Protected field contains the information specific to the current request (Inherited from abstractHtmlSubwriter.)

Properties

	Name	Description
	Body_Attributes	Gets the collection of body attributes to be included within the HTML body tag (usually to add events to the body) (Overrides abstractHtmlSubwriter..::..Body_Attributes.)
	Container_CssClass	Gets the CSS class of the container that the page is wrapped within (Overrides abstractHtmlSubwriter..::..Container_CssClass.)
	Final_CSS	Chance for a final, final CSS which can override anything else, including the web skin (Overrides abstractHtmlSubwriter..::..Final_CSS.)
	Include_Internal_Header	Flag indicates if the internal header should included (Overrides abstractHtmlSubwriter..::..Include_Internal_Header.)
	Subwriter_Behaviors	Gets the collection of special behaviors which this subwriter requests from the main HTML subwriter. (Overrides abstractHtmlSubwriter..::..Subwriter_Behaviors.)
	Upload_File_Possible	Returns a flag indicating whether the file upload specific holder in the itemNavForm form will be utilized for the current request, or if it can be hidden. (Inherited from abstractHtmlSubwriter.)
	WebPage_Title	Title for this web page (Overrides abstractHtmlSubwriter..::..WebPage_Title.)