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

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

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

Inheritance: abstract_Element

Protected Properties

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
Set_Values ( string values ) : void	Sets all of the possible, selectable values

Method	Description
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 a options subelement and the default value from a value subelement
comboBox_Element ( string Title, string Html_Element_Name ) : System	Constructor for a new instance of the comboBox_Element class
render_helper ( TextWriter Output, string instance_value, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL ) : void	Method helps to render all single combo box based elements
render_helper ( TextWriter Output, string instance_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 all single combo box based elements

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 a new possible, selectable value to this combo box

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

Reads the inner data from the CompleteTemplate XML format

This reads the possible values for the 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

Sets all of the possible, selectable values

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

Constructor for a new instance of the comboBox_Element class

protected comboBox_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

Method helps to render all single combo box based elements

protected render_helper ( TextWriter Output, string instance_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 generated html for this element
instance_value	string	Value for the current digital resource to display
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

Method helps to render all single combo box based elements

protected render_helper ( TextWriter Output, string instance_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 generated html for this element
instance_value	string	Value for the current digital resource to display
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 instance_value param is actually instructional text, and not a true value
return	void

Protected field holds the default value(s)

protected List default_values
return	List

Protected field holds all the possible, selectable values

protected List items
return	List

Protected field holds the onchange event text to add to the html

protected string onChange
return	string

Protected field holds the flag that tells if a value from the package which is not in the provided options should be discarded or permitted

protected bool restrict_values
return	bool