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

Abstract base class for all elements which are made up of a single combo/select box followed by a text box

This class implements the iElement interface and extends the abstract_Element class.

Inheritance: abstract_Element

Show file Open project: MarkVSullivan/SobekCM-Web-Application

Protected Properties

Property	Type	Description
clear_textbox_on_combobox_change	bool
code_to_statement_dictionary	string>.Dictionary
default_codes	List
default_values	List
possible_select_items	List
second_label	string

Public Methods

Method	Description
Add_Item ( string newitem ) : void	Adds a possible, selectable value to the combo/select box

Protected Methods

Method	Description
Add_Code_Statement_Link ( string code, string statement ) : void	Adds a link between a code and default statement, so that selecting the code will set the corresponding default statement
Inner_Read_Data ( XmlTextReader XMLReader ) : void	Reads the inner data from the CompleteTemplate XML format This reads the possible values for the combo box from an options subelement. The default value for the combo box is from a code subelement and the default value for the text box is from a statement subelement.
comboBox_TextBox_Element ( string Title, string Html_Element_Name ) : System	Constructor for a new instance of the comboBox_TextBox_Element class
render_helper ( TextWriter Output, List select_values, List text_values, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL ) : void	Method helps to render the html for all elements based on comboBox_TextBox_Element class
render_helper ( TextWriter Output, string select_value, List userdefined_possible, string text_value, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, bool initial_value ) : void	Method helps to render the html for all elements based on comboBox_TextBox_Element class
render_helper ( TextWriter Output, string select_value, string text_value, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL ) : void	Method helps to render the html for all elements based on the comboBox_TextBox_Element class
render_helper ( TextWriter Output, string select_value, string text_value, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, bool initial_value ) : void	Method helps to render the html for all elements based on comboBox_TextBox_Element class

Method Details

Add_Code_Statement_Link() protected method

Adds a link between a code and default statement, so that selecting the code will set the corresponding default statement

protected Add_Code_Statement_Link ( string code, string statement ) : void
code	string	Code
statement	string	Default statement for that code
return	void

Add_Item() public method

Adds a possible, selectable value to the combo/select box

public Add_Item ( string newitem ) : void
newitem	string	New possible, selectable value
return	void

Inner_Read_Data() protected method

Reads the inner data from the CompleteTemplate XML format

This reads the possible values for the combo box from an options subelement. The default value for the combo box is from a code subelement and the default value for the text box is from a statement subelement.

protected Inner_Read_Data ( XmlTextReader XMLReader ) : void
XMLReader	System.Xml.XmlTextReader	Current template xml configuration reader
return	void

comboBox_TextBox_Element() protected method

Constructor for a new instance of the comboBox_TextBox_Element class

protected comboBox_TextBox_Element ( string Title, string Html_Element_Name ) : System
Title	string	Title for this element
Html_Element_Name	string	Name for the html components and styles for this element
return	System

render_helper() protected method

Method helps to render the html for all elements based on comboBox_TextBox_Element class

protected render_helper ( TextWriter Output, List select_values, List text_values, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL ) : void
Output	System.IO.TextWriter	Output for the generate html for this element
select_values	List	Value(s) for the current digital resource to display in the combo box
text_values	List	Value(s) for the current digital resource to display in the text box
Skin_Code	string	Code for the current html skin
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

render_helper() protected method

Method helps to render the html for all elements based on comboBox_TextBox_Element class

protected render_helper ( TextWriter Output, string select_value, List userdefined_possible, string text_value, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, bool initial_value ) : void
Output	System.IO.TextWriter	Output for the generate html for this element
select_value	string	Value for the current digital resource to display in the combo box
userdefined_possible	List	List of possible select values, set by the user
text_value	string	Value for the current digital resource to display in the text box
Skin_Code	string	Code for the current html skin
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
initial_value	bool	Flag indicates if the value in the select_value param is actually instructional text, and not a true value
return	void

render_helper() protected method

Method helps to render the html for all elements based on the comboBox_TextBox_Element class

protected render_helper ( TextWriter Output, string select_value, string text_value, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL ) : void
Output	System.IO.TextWriter	Output for the generate html for this element
select_value	string	Value for the current digital resource to display in the combo box
text_value	string	Value for the current digital resource to display in the text box
Skin_Code	string	Code for the current html skin
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

render_helper() protected method

Method helps to render the html for all elements based on comboBox_TextBox_Element class

protected render_helper ( TextWriter Output, string select_value, string text_value, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, bool initial_value ) : void
Output	System.IO.TextWriter	Output for the generate html for this element
select_value	string	Value for the current digital resource to display in the combo box
text_value	string	Value for the current digital resource to display in the text box
Skin_Code	string	Code for the current html skin
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
initial_value	bool	Flag indicates if the value in the select_value param is actually instructional text, and not a true value
return	void

Property Details

clear_textbox_on_combobox_change protected property

Flag indicates if the text box should be cleared when the combo box changes

protected bool clear_textbox_on_combobox_change
return	bool

code_to_statement_dictionary protected property

Protected field holds the dictionary that maps from a code to a statement

This is only used if selecting a code should set a default statement

protected Dictionary code_to_statement_dictionary
return	string>.Dictionary

default_codes protected property

Protected field holds the default value(s) for the combo box

protected List default_codes
return	List

default_values protected property

Protected field holds the default value(s) for the text box

protected List default_values
return	List

possible_select_items protected property

Protected field holds all of the possible, selectable values for the combo box

protected List possible_select_items
return	List

second_label protected property

Protected field holds any label to place before the text box, after the combo box

protected string second_label
return	string