Preferences_MySobekViewer Class

Class allows an unauthenticated user to register and an authenticated user to change their preferences

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

Syntax

C#
public class Preferences_MySobekViewer : abstract_MySobekViewer

Remarks

This class extends the abstract_MySobekViewer class.

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. Since this action requires authentication, an instance of the MySobek_HtmlSubwriter class is created.
The mySobek subwriter creates an instance of this viewer for either registering or changing their preferences

Inheritance Hierarchy

System..::..Object
SobekCM.Library.MySobekViewer..::..abstract_MySobekViewer
SobekCM.Library.MySobekViewer..::..Preferences_MySobekViewer

Constructors

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

Methods

	Name	Description
	Add_Controls	Add controls directly to the form in the main control area placeholder (Inherited from abstract_MySobekViewer.)
	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 (Inherited from abstract_MySobekViewer.)
	Write_HTML	Add the HTML to be displayed in the main SobekCM viewer area (outside of any form) (Overrides abstract_MySobekViewer..::..Write_HTML(TextWriter, Custom_Tracer).)
	Write_Item_Type_Top(TextWriter, BriefItemInfo)	Writes the top part of the page, mimicing the item viewer (Inherited from abstract_MySobekViewer.)
	Write_Item_Type_Top(TextWriter, SobekCM_Item)	Writes the top part of the page, mimicing the item viewer (Inherited from abstract_MySobekViewer.)
	Write_ItemNavForm_Closing	This is an opportunity to write HTML directly into the main form, without using the pop-up html form architecture (Inherited from abstract_MySobekViewer.)
	Write_ItemNavForm_Opening	Add the HTML to be displayed in the main SobekCM viewer area with the form (Overrides abstract_MySobekViewer..::..Write_ItemNavForm_Opening(TextWriter, Custom_Tracer).)
	Write_Within_HTML_Head	Write any additional values within the HTML Head of the final served page (Inherited from abstract_MySobekViewer.)

Fields

	Name	Description
	RequestSpecificValues	Protected field contains all the necessary, non-global data specific to the current request (Inherited from abstract_MySobekViewer.)

Properties

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