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 >> Item_HtmlSubwriter

Item_HtmlSubwriter Class



Item html subwriter renders views on a single digital resource


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

Syntax

C#
public class Item_HtmlSubwriter : abstractHtmlSubwriter

Remarks

This class extends the abstractHtmlSubwriter abstract class.

Inheritance Hierarchy

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

Constructors

  NameDescription
Public methodItem_HtmlSubwriter
Constructor for a new instance of the Item_HtmlSubwriter class

Methods

  NameDescription
Public methodAdd_Footer
Add the footer to the output
(Inherited from abstractHtmlSubwriter.)
Public methodAdd_Header
Add the header to the output
(Inherited from abstractHtmlSubwriter.)
Public methodAdd_Main_Viewer_Section
Performs the final HTML writing which completes the item table and adds the final page navigation buttons at the bottom of the page
Public methodAdd_Standard_TOC
Adds the table of contents as a control in the left navigation bar
Public methodCreate_TreeView_From_Divisions
Populates the tree view with the divisions from the current digital resource item
Public methodWrite_Additional_HTML
Writes the HTML generated by this item html subwriter directly to the response stream
(Overrides abstractHtmlSubwriter..::..Write_Additional_HTML(TextWriter, Custom_Tracer).)
Public methodWrite_Final_HTML
Spot to write any final HTML to the response stream
(Overrides abstractHtmlSubwriter..::..Write_Final_HTML(TextWriter, Custom_Tracer).)
Public methodWrite_HTML
Writes the HTML generated by this item html subwriter 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
(Overrides abstractHtmlSubwriter..::..Write_Internal_Header_HTML(TextWriter, User_Object).)
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.
(Overrides abstractHtmlSubwriter..::..Write_ItemNavForm_Closing(TextWriter, Custom_Tracer).)
Public methodWrite_ItemNavForm_Opening
Writes the html to the output stream open the itemNavForm, which appears just before the TocPlaceHolder
(Overrides abstractHtmlSubwriter..::..Write_ItemNavForm_Opening(TextWriter, Custom_Tracer).)
Public methodWrite_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

  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)
(Overrides abstractHtmlSubwriter..::..Body_Attributes.)
Public propertyContainer_CssClass
Gets the CSS class of the container that the page is wrapped within
(Overrides abstractHtmlSubwriter..::..Container_CssClass.)
Public propertyFinal_CSS
Chance for a final, final CSS which can override anything else, including the web skin
(Inherited from abstractHtmlSubwriter.)
Public propertyInclude_Internal_Header
Flag indicates if the internal header should included
(Overrides abstractHtmlSubwriter..::..Include_Internal_Header.)
Public propertyItem_Checked_Out_By_Other_User
Flag indicates this item is currently checked out by another user
Public propertyPageViewer
Gets and sets the page viewer used to display the current item
Public propertySubwriter_Behaviors
Gets the collection of special behaviors which this subwriter requests from the main HTML subwriter.
(Overrides abstractHtmlSubwriter..::..Subwriter_Behaviors.)
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
(Overrides abstractHtmlSubwriter..::..WebPage_Title.)

See Also



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