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

Element allows IR-specific entry of the material type and related larger body of work for an item
This class implements the iElement interface and extends the abstract_Element class.
Inheritance: abstract_Element
ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method Description
Add_Default_Value ( string defaultValue ) : void

Adds a default value for this combo box based element

Add_Item ( string newItem ) : void

Add a new possible, selectable value to this combo box

IR_Type_Element ( ) : System

Constructor for a new instance of the IR_Type_Element class

Prepare_For_Save ( SobekCM_Item Bib, User_Object Current_User ) : void

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

This does nothing since there is only one type

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

Renders the HTML for this element

This simple element does not append any popup form to the popup_form_builder

Save_To_Bib ( SobekCM_Item Bib ) : void

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

Set_Values ( string values ) : void

Sets all of the possible, selectable values

Protected Methods

Method Description
Inner_Read_Data ( XmlTextReader XMLReader ) : void

Reads the inner data from the CompleteTemplate XML format

This reads the possible values for the type combo box from a options subelement and the default value from a value subelement

Method Details

Add_Default_Value() public method

Adds a default value for this combo box based element
public Add_Default_Value ( string defaultValue ) : void
defaultValue string New default value
return void

Add_Item() public method

Add a new possible, selectable value to this combo box
public Add_Item ( string newItem ) : void
newItem string New possible, selectable value
return void

IR_Type_Element() public method

Constructor for a new instance of the IR_Type_Element class
public IR_Type_Element ( ) : System
return System

Inner_Read_Data() protected method

Reads the inner data from the CompleteTemplate XML format
This reads the possible values for the type combo box from a options subelement and the default value from a value subelement
protected Inner_Read_Data ( XmlTextReader XMLReader ) : void
XMLReader System.Xml.XmlTextReader Current template xml configuration reader
return void

Prepare_For_Save() public method

Prepares the bib object for the save, by clearing any existing data in this element's related field(s)
This does nothing since there is only one type
public Prepare_For_Save ( SobekCM_Item Bib, 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.Core.Users.User_Object Current user, who's rights may impact the way an element is rendered
return void

Render_Template_HTML() public method

Renders the HTML for this element
This simple element does not append any popup form to the popup_form_builder
public Render_Template_HTML ( TextWriter Output, SobekCM_Item Bib, string Skin_Code, bool IsMozilla, StringBuilder PopupFormBuilder, User_Object Current_User, Web_Language_Enum CurrentLanguage, 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.Core.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.Core.ApplicationState.Language_Support_Info Language support object which handles simple translational duties
Base_URL string Base URL for the current request
return void

Save_To_Bib() public method

Saves the data rendered by this element to the provided bibliographic object during postback
public 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_Values() public method

Sets all of the possible, selectable values
public Set_Values ( string values ) : void
values string Array of possible, selectable values
return void