C# Class SobekCM.Library.AdminViewer.abstract_AdminViewer

Inheritance: iMySobek_Admin_Viewer
ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application

Protected Properties

Property Type Description
RequestSpecificValues RequestCache
emptybehaviors List

Public Methods

Method Description
Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void

Add controls directly to the form in the main control area placeholder

No controls are added here, although some children class override this virtual method to add controls

Add_Popup_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void

Add the HTML to be added near the top of the page for those viewers that implement pop-up forms for data retrieval

No html is added here, although some children class override this virtual method to add pop-up form HTML

Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void

Add the HTML to be displayed in the main SobekCM viewer area (outside of any form)

Abstract method must be implemented by all extending classes

Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void

This is an opportunity to write HTML directly into the main form, without using the pop-up html form architecture

This text will appear within the ItemNavForm form tags

Write_ItemNavForm_Opening ( TextWriter Output, Custom_Tracer Tracer ) : void

This is an opportunity to write HTML directly into the main form before any controls are placed in the main place holder

This text will appear within the ItemNavForm form tags

Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : bool

Write any additional values within the HTML Head of the final served page

By default this does nothing, but can be overwritten by all the individual html subwriters

Protected Methods

Method Description
abstract_AdminViewer ( RequestCache RequestSpecificValues ) : System.Collections.Generic

Constructor for a new instance of the abstract_AdminViewer class

Method Details

Add_Controls() public method

Add controls directly to the form in the main control area placeholder
No controls are added here, although some children class override this virtual method to add controls
public Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder System.Web.UI.WebControls.PlaceHolder Main place holder to which all main controls are added
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void

Add_Popup_HTML() public method

Add the HTML to be added near the top of the page for those viewers that implement pop-up forms for data retrieval
No html is added here, although some children class override this virtual method to add pop-up form HTML
public Add_Popup_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Textwriter to write the pop-up form HTML for this viewer
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void

Write_HTML() public abstract method

Add the HTML to be displayed in the main SobekCM viewer area (outside of any form)
Abstract method must be implemented by all extending classes
public abstract Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Textwriter to write the HTML for this viewer
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void

Write_ItemNavForm_Closing() public method

This is an opportunity to write HTML directly into the main form, without using the pop-up html form architecture
This text will appear within the ItemNavForm form tags
public Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Textwriter to write the pop-up form HTML for this viewer
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void

Write_ItemNavForm_Opening() public method

This is an opportunity to write HTML directly into the main form before any controls are placed in the main place holder
This text will appear within the ItemNavForm form tags
public Write_ItemNavForm_Opening ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Textwriter to write the pop-up form HTML for this viewer
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void

Write_Within_HTML_Head() public method

Write any additional values within the HTML Head of the final served page
By default this does nothing, but can be overwritten by all the individual html subwriters
public Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : bool
Output System.IO.TextWriter Output stream currently within the HTML head tags
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return bool

abstract_AdminViewer() protected method

Constructor for a new instance of the abstract_AdminViewer class
protected abstract_AdminViewer ( RequestCache RequestSpecificValues ) : System.Collections.Generic
RequestSpecificValues RequestCache All the necessary, non-global data specific to the current request
return System.Collections.Generic

Property Details

RequestSpecificValues protected_oe property

Protected field contains the information specific to the current request
protected RequestCache RequestSpecificValues
return RequestCache

emptybehaviors protected_oe static_oe property

Empty list of behaviors, returned by default
This just prevents an empty set from having to be created over and over
protected static List emptybehaviors
return List