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

MySobek_HtmlSubwriter Class



My Sobek html subwriter is used for registration and authentication with mySobek, as well as performing any task which requires authentication, such as online submittal, metadata editing, and system administrative tasks


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

Syntax

C#
public class MySobek_HtmlSubwriter : abstractHtmlSubwriter

Remarks

This class extends the abstractHtmlSubwriter abstract class.

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 this necessary subwriter since this action requires authentication.
  • This class will create a mySobek subwriter (extending abstract_MySobekViewer ) for the specified task.The mySobek subwriter creates an instance of this viewer to view and edit existing item aggregationPermissions in this digital library

Inheritance Hierarchy

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

Constructors

  NameDescription
Public methodMySobek_HtmlSubwriter
Constructor for a new instance of the MySobek_HtmlSubwriter class

Methods

  NameDescription
Public methodAdd_Controls
Adds any necessary controls to one of two place holders on the main ASPX page
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 methodWrite_Additional_HTML
Writes additional HTML needed in the main form before the main place holder but after the other place holders.
(Overrides abstractHtmlSubwriter..::..Write_Additional_HTML(TextWriter, Custom_Tracer).)
Public methodWrite_Final_HTML
Writes final HTML after all the forms
(Overrides abstractHtmlSubwriter..::..Write_Final_HTML(TextWriter, Custom_Tracer).)
Public methodWrite_HTML
Writes the HTML generated by this my sobek 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
(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.
(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)
(Inherited from abstractHtmlSubwriter.)
Public propertyContainer_CssClass
Gets the CSS class of the container that the page is wrapped within
(Overrides abstractHtmlSubwriter..::..Container_CssClass.)
Public propertyContains_Popup_Forms
Property indicates if the current mySobek viewer can contain pop-up forms
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
(Inherited from abstractHtmlSubwriter.)
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.
(Overrides abstractHtmlSubwriter..::..Upload_File_Possible.)
Public propertyWebPage_Title
Title for this web page
(Inherited from abstractHtmlSubwriter.)

See Also



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