C# Class SobekCM.Library.Citation.Elements.abstract_Element

Abstract class which all html metadata element classes must extend
This implements the iElement interface.
Inheritance: iElement
Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Protected Properties

Property Type Description
HELP_BUTTON_URL string
REPEAT_BUTTON_URL string
help_page string
html_element_name string

Public Methods

Method Description
Prepare_For_Save ( SobekCM_Item Bib, SobekCM.Library.Users.User_Object Current_User ) : void

Prepares the bib object for the save, by clearing any existing data in this element's related field(s)

Read_XML ( XmlTextReader xmlReader ) : void

Reads from the template XML format

Render_Template_HTML ( TextWriter Output, SobekCM_Item Bib, string Skin_Code, bool IsMozilla, StringBuilder PopupFormBuilder, SobekCM.Library.Users.User_Object Current_User, Web_Language_Enum CurrentLanguage, SobekCM.Library.Application_State.Language_Support_Info Translator, string Base_URL ) : void

Renders the HTML for this element

Save_Constant_To_Bib ( SobekCM_Item Bib ) : void

Saves the constants to the bib id

Save_To_Bib ( SobekCM_Item Bib ) : void

Saves the data rendered by this element to the provided bibliographic object during postback

Set_Base_URL ( string Base_URL ) : void

Sets the base url for the current request

This does nothing, although it can be override by extending classes

Protected Methods

Method Description
Close_Button_URL ( string Skin_Code, string Button_Base_URL ) : string

Return the HTML for the close button image for a given html interface

Help_URL ( string Skin_Code, string Current_Base_URL ) : string

Returns the URL for the element help for a given html interface

Inner_Read_Data ( XmlTextReader XMLReader ) : void

Reads the inner data from the CompleteTemplate XML format

abstract_Element ( ) : System

Constructor for a new abstract element object

Method Details

Close_Button_URL() protected method

Return the HTML for the close button image for a given html interface
protected Close_Button_URL ( string Skin_Code, string Button_Base_URL ) : string
Skin_Code string Code for the current html skin
Button_Base_URL string Base URL for the current request
return string

Help_URL() protected method

Returns the URL for the element help for a given html interface
protected Help_URL ( string Skin_Code, string Current_Base_URL ) : string
Skin_Code string Code for the current html skin
Current_Base_URL string Base URL for the current request
return string

Inner_Read_Data() protected abstract method

Reads the inner data from the CompleteTemplate XML format
protected abstract Inner_Read_Data ( XmlTextReader XMLReader ) : void
XMLReader System.Xml.XmlTextReader Current template xml configuration reader
return void

Prepare_For_Save() public abstract method

Prepares the bib object for the save, by clearing any existing data in this element's related field(s)
public abstract Prepare_For_Save ( SobekCM_Item Bib, SobekCM.Library.Users.User_Object Current_User ) : void
Bib SobekCM.Resource_Object.SobekCM_Item Existing digital resource object which may already have values for this element's data field(s)
Current_User SobekCM.Library.Users.User_Object Current user, who's rights may impact the way an element is rendered
return void

Read_XML() public method

Reads from the template XML format
public Read_XML ( XmlTextReader xmlReader ) : void
xmlReader System.Xml.XmlTextReader Current template xml configuration reader
return void

Render_Template_HTML() public abstract method

Renders the HTML for this element
public abstract Render_Template_HTML ( TextWriter Output, SobekCM_Item Bib, string Skin_Code, bool IsMozilla, StringBuilder PopupFormBuilder, SobekCM.Library.Users.User_Object Current_User, Web_Language_Enum CurrentLanguage, SobekCM.Library.Application_State.Language_Support_Info Translator, string Base_URL ) : void
Output System.IO.TextWriter Textwriter to write the HTML for this element
Bib SobekCM.Resource_Object.SobekCM_Item Object to populate this element from
Skin_Code string Code for the current skin
IsMozilla bool Flag indicates if the current browse is Mozilla Firefox (different css choices for some elements)
PopupFormBuilder StringBuilder Builder for any related popup forms for this element
Current_User SobekCM.Library.Users.User_Object Current user, who's rights may impact the way an element is rendered
CurrentLanguage Web_Language_Enum Current user-interface language
Translator SobekCM.Library.Application_State.Language_Support_Info Language support object which handles simple translational duties
Base_URL string Base URL for the current request
return void

Save_Constant_To_Bib() public method

Saves the constants to the bib id
public Save_Constant_To_Bib ( SobekCM_Item Bib ) : void
Bib SobekCM.Resource_Object.SobekCM_Item Object into which to save this element's constant data
return void

Save_To_Bib() public abstract method

Saves the data rendered by this element to the provided bibliographic object during postback
public abstract Save_To_Bib ( SobekCM_Item Bib ) : void
Bib SobekCM.Resource_Object.SobekCM_Item Object into which to save the user's data, entered into the html rendered by this element
return void

Set_Base_URL() public method

Sets the base url for the current request
This does nothing, although it can be override by extending classes
public Set_Base_URL ( string Base_URL ) : void
Base_URL string Current Base URL for this request
return void

abstract_Element() protected method

Constructor for a new abstract element object
protected abstract_Element ( ) : System
return System

Property Details

HELP_BUTTON_URL protected_oe property

Constant defines the url for the repeat button image for all metadata element objects
protected string HELP_BUTTON_URL
return string

REPEAT_BUTTON_URL protected_oe property

Constant defines the url for the repeat button image for all metadata element objects
protected string REPEAT_BUTTON_URL
return string

help_page protected_oe property

Name of the help page, if different than default
protected string help_page
return string

html_element_name protected_oe property

Name used for style sheet references and html id's for this subtype of this element
protected string html_element_name
return string