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 >> AdminViewer >> iMySobek_Admin_Viewer Interface

iMySobek_Admin_Viewer Interface



Interface defines the required behavior for the mySobek and administrative viewers


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

Syntax

C#
public interface iMySobek_Admin_Viewer

Methods

  NameDescription
Public methodAdd_Controls
Add controls directly to the form in the main control area placeholder
Public methodAdd_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
Public methodWrite_HTML
Add the HTML to be displayed in the main SobekCM viewer area (outside of any form)
Public methodWrite_ItemNavForm_Closing
This is an opportunity to write HTML directly into the main form after any controls are placed
Public methodWrite_ItemNavForm_Opening
This is an opportunity to write HTML directly into the main form before any controls are placed in the main place holder
Public methodWrite_Within_HTML_Head
Write any additional values within the HTML Head of the final served page

Properties

  NameDescription
Public propertyContainer_CssClass
Gets the CSS class of the container that the page is wrapped within
Public propertyContains_Popup_Forms
Property indicates if this mySobek viewer can contain pop-up forms
Public propertyRequires_Logged_In_User
Flag indicates if a user must be logged in to access this admin or mySobek view.
Public propertyStandard_Navigation_Type
Navigation type to be displayed (mostly used by the mySobek viewers)
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/omitted.
Public propertyViewer_Behaviors
Gets the collection of special behaviors which this admin or mySobek viewer requests from the main HTML subwriter.
Public propertyViewer_Icon
Gets the URL for the icon related to this administrative task
Public propertyWeb_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

See Also



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