mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='https://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='https://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='https://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='https://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='https://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
MISSING BANNER
Code Details >> Library >> HTML >> PagedResults_HtmlSubwriter

PagedResults_HtmlSubwriter Class



Accepts a result set of titles and items and renders the correct page of results in the result view the user has requested


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

Syntax

C#
public class PagedResults_HtmlSubwriter : abstractHtmlSubwriter

Remarks

This class extends the abstractHtmlSubwriter abstract class.

Inheritance Hierarchy

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

Constructors

  NameDescription
Public methodPagedResults_HtmlSubwriter
Constructor for a new instance of the paged_result_html_subwriter class

Methods

  NameDescription
Public methodAdd_Controls
Adds controls to the main navigational page
Protected methodAdd_Facet_Information
Returns the facets for this result/browse as HTML to be added into the form
Public methodAdd_Footer
Add the footer to the output
(Inherited from abstractHtmlSubwriter.)
Public methodAdd_Header
Add the header to the output
(Inherited from abstractHtmlSubwriter.)
Protected methodShow_Search_Info
Renders the text about this search (i.e., "Your search for ... resulted in ..." ) directly to the output stream
Public methodWrite_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.)
Public methodWrite_Final_HTML
Writes the final output to close this result view, including the results page navigation buttons
(Overrides abstractHtmlSubwriter..::..Write_Final_HTML(TextWriter, Custom_Tracer).)
Public methodWrite_HTML
Writes the HTML generated to browse the list of titles/itemsr directly to the response stream
(Overrides abstractHtmlSubwriter..::..Write_HTML(TextWriter, Custom_Tracer).)
Public methodWrite_Internal_Header_HTML
Adds the internal header HTML for this specific HTML writer
(Inherited from abstractHtmlSubwriter.)
Protected methodWrite_Internal_Header_Search_Box
Adds the internal header search box to the current output stream
(Inherited from abstractHtmlSubwriter.)
Public methodWrite_ItemNavForm_Closing
Writes final HTML to the output stream after all the placeholders and just before the itemNavForm is closed.
(Inherited from abstractHtmlSubwriter.)
Public methodWrite_ItemNavForm_Opening
Writes the html to the output stream open the itemNavForm, which appears just before the TocPlaceHolder
(Inherited from abstractHtmlSubwriter.)
Public methodWrite_Within_HTML_Head
Write any additional values within the HTML Head of the final served page
(Inherited from abstractHtmlSubwriter.)

Fields

  NameDescription
Protected fieldRequestSpecificValues
Protected field contains the information specific to the current request
(Inherited from abstractHtmlSubwriter.)

Properties

  NameDescription
Public propertyBody_Attributes
Gets the collection of body attributes to be included within the HTML body tag (usually to add events to the body)
(Inherited from abstractHtmlSubwriter.)
Public propertyBrowse_Title
Title for the current view, which is used rather than the search explanation
Public propertyContainer_CssClass
Gets the CSS class of the container that the page is wrapped within
(Inherited from abstractHtmlSubwriter.)
Public propertyFinal_CSS
Chance for a final, final CSS which can override anything else, including the web skin
(Inherited from abstractHtmlSubwriter.)
Public propertyFolder_Owner_Email
Email of the owner of this folder
Public propertyFolder_Owner_Name
Name of the owner of this folder
Public propertyInclude_Bookshelf_View
Flag indicates if the bookshelf view should be included in the list of possible views
Public propertyInclude_Internal_Header
Flag indicates if the internal header should included
(Inherited from abstractHtmlSubwriter.)
Public propertyOuter_Form_Name
If the results dataset should be displayed in the context of an outer form (such as in the case that this is part of the mySobek bookshelf functionality) then the form name should go here. If no outer form name is provided, this will create its own sort form
Public propertyShowing_Text
Text which indicates which values of the current result or browse are being shown
Public propertySubwriter_Behaviors
Gets the collection of special behaviors which this subwriter requests from the main HTML writer.
(Inherited from abstractHtmlSubwriter.)
Public propertyUpload_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.)
Public propertyWebPage_Title
Title for this web page
(Inherited from abstractHtmlSubwriter.)

See Also



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