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

Abstract base class for all elements which are made up of a simple text box

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

Inheritance: abstract_Element

Exibir arquivo Open project: MarkVSullivan/SobekCM-Web-Application

Protected Properties

Property	Type	Description
default_values	List
fixed_type_from_template_file	string
label_from_template_file	string
view_choices_string	string

Public Methods

Method	Description
Add_Default_Value ( string defaultValue ) : void	Adds a new default value for this multiple text box type element

Protected Methods

Method	Description
Inner_Read_Data ( XmlTextReader XMLReader ) : void	Reads the inner data from the CompleteTemplate XML format This reads the default value from a value subelement and the label subelement, which is used in several of the classes that extend this one
render_helper ( TextWriter Output, List instance_values, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL ) : void	Method helps to render all simple text box based elements
render_helper ( TextWriter Output, List instance_values, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, string HTML_ID_Name ) : void	Method helps to render all simple text box based elements
render_helper ( TextWriter Output, ReadOnlyCollection instance_values, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL ) : void	Method helps to render all simple text box based elements
render_helper ( TextWriter Output, ReadOnlyCollection instance_values, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, string HTML_ID_Name ) : void	Method helps to render all simple text 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 ) : void	Method helps to render all multiple text 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, string HTML_ID_Name ) : void	Method helps to render all multiple text box based elements
simpleTextBox_Element ( string Title, string Html_Element_Name ) : System	Constructor for a new instance of the simpleTextBox_Element class

Method Details

Add_Default_Value() public method

Adds a new default value for this multiple text box type element

public Add_Default_Value ( string defaultValue ) : void
defaultValue	string	New default value
return	void

Inner_Read_Data() protected method

Reads the inner data from the CompleteTemplate XML format

This reads the default value from a value subelement and the label subelement, which is used in several of the classes that extend this one

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

render_helper() protected method

Method helps to render all simple text box based elements

protected render_helper ( TextWriter Output, List instance_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 generated html for this element
instance_values	List	Value(s) 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

render_helper() protected method

Method helps to render all simple text box based elements

protected render_helper ( TextWriter Output, List instance_values, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, string HTML_ID_Name ) : void
Output	System.IO.TextWriter	Output for the generated html for this element
instance_values	List	Value(s) 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
HTML_ID_Name	string	ID name used for these elements. This is usually provided when there are multiple fixed-roles or fixed-type elements
return	void

render_helper() protected method

Method helps to render all simple text box based elements

protected render_helper ( TextWriter Output, ReadOnlyCollection instance_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 generated html for this element
instance_values	ReadOnlyCollection	Value(s) 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

render_helper() protected method

Method helps to render all simple text box based elements

protected render_helper ( TextWriter Output, ReadOnlyCollection instance_values, string Skin_Code, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, string HTML_ID_Name ) : void
Output	System.IO.TextWriter	Output for the generated html for this element
instance_values	ReadOnlyCollection	Value(s) 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
HTML_ID_Name	string	ID name used for these elements. This is usually provided when there are multiple fixed-roles or fixed-type elements
return	void

render_helper() protected method

Method helps to render all multiple text 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

render_helper() protected method

Method helps to render all multiple text 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, string HTML_ID_Name ) : 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
HTML_ID_Name	string	ID name used for these elements. This is usually provided when there are multiple fixed-roles or fixed-type elements
return	void

simpleTextBox_Element() protected method

Constructor for a new instance of the simpleTextBox_Element class

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

Property Details

default_values protected_oe property

Protected field holds all the default values to display

protected List default_values
return	List

fixed_type_from_template_file protected_oe property

Protected field holds the fixed type field from the template file

protected string fixed_type_from_template_file
return	string

label_from_template_file protected_oe property

Protected field holds the label field from the template file

protected string label_from_template_file
return	string

view_choices_string protected_oe property

Protected field holds any html to insert as the view choices option after the boxes

protected string view_choices_string
return	string