abstract_MySobekViewer Class

Abstract class which all mySobek viewer classes extend

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

Syntax

C#
public abstract class abstract_MySobekViewer : iMySobek_Admin_Viewer

Remarks

MySobek Viewers are 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.

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. If the action requires authentication, an instance of the MySobek_HtmlSubwriter class is created.
To allow the requested action, the mySobek subwriter will create one of the mySobek viewers( implementing this class )

Inheritance Hierarchy

Constructors

	Name	Description
	abstract_MySobekViewer	Constructor for a new instance of the abstract_MySobekViewer class

Methods

	Name	Description
	Add_Controls	Add controls directly to the form in the main control area placeholder
	Add_Popup_HTML	Add the HTML to be added near the top of the page for those viewers that implement pop-up forms for data retrieval
	Write_HTML	Add the HTML to be displayed in the main SobekCM viewer area (outside of any form)
	Write_Item_Type_Top(TextWriter, BriefItemInfo)	Writes the top part of the page, mimicing the item viewer
	Write_Item_Type_Top(TextWriter, SobekCM_Item)	Writes the top part of the page, mimicing the item viewer
	Write_ItemNavForm_Closing	This is an opportunity to write HTML directly into the main form, without using the pop-up html form architecture
	Write_ItemNavForm_Opening	This is an opportunity to write HTML directly into the main form before any controls are placed in the main place holder
	Write_Within_HTML_Head	Write any additional values within the HTML Head of the final served page

Fields

	Name	Description
	emptybehaviors	Empty list of behaviors, returned by default
	RequestSpecificValues	Protected field contains all the necessary, non-global data specific to the current request

Properties

	Name	Description
	Container_CssClass	Gets the CSS class of the container that the page is wrapped within
	Contains_Popup_Forms	Property indicates if this mySobek viewer can contain pop-up forms
	Requires_Logged_In_User	Flag indicates if a user must be logged in to access this admin or mySobek view.
	Standard_Navigation_Type	Navigation type to be displayed (mostly used by the mySobek viewers)
	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/omitted.
	Viewer_Behaviors	Gets the collection of special behaviors which this admin or mySobek viewer requests from the main HTML subwriter.
	Viewer_Icon	Gets the URL for the icon related to this mySobek task
	Web_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