C# Class SobekCM.Library.Citation.Template.CompleteTemplate

Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method	Description
Build_Final_Adjustment_And_Checks ( ) : void	Steps through each element after reading the template information and ensures that any element that must be aware of a comparable element's existence is notified ( such as creator/contributor ).
CompleteTemplate ( ) : System	Constructor for a new instance of the CompleteTemplate class
CompleteTemplate ( string Name ) : System	Constructor for a new instance of the CompleteTemplate class
Read_XML_Template ( string XmlFile ) : CompleteTemplate	Static method reads a template XML configuraton file and creates the CompleteTemplate object This utilizes the Template_XML_Reader class to do the actual reading
Read_XML_Template ( string XmlFile, bool ExcludeDivisions ) : CompleteTemplate	Static method reads a template XML configuraton file and creates the CompleteTemplate object This utilizes the Template_XML_Reader class to do the actual reading
Render_Template_HTML ( TextWriter Output, SobekCM_Item Bib, string Skin_Code, bool isMozilla, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, Navigation_Object Current_Mode ) : string	Displays an item as HTML using this template
Render_Template_HTML ( TextWriter Output, SobekCM_Item Bib, string Skin_Code, bool isMozilla, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, int page ) : string	Displays one page worth of elements from an item as HTML using this template
Save_To_Bib ( SobekCM_Item Bib, User_Object Current_User ) : void	Saves the data entered by the user through this template to the provided bibliographic object
Save_To_Bib ( SobekCM_Item Bib, User_Object Current_User, int Page ) : void	Saves the data entered by the user through one page of this template to the provided bibliographic object

Private Methods

Method	Description
Add_Constant ( abstract_Element NewConstant ) : void	Adds a new constant to the collection of constants contained within this template
Add_Page ( SobekCM.Library.Citation.Template.Template_Page NewPage ) : void	Adds a new template page to the collection of pages contained within this template

Method Details

Build_Final_Adjustment_And_Checks() public method

Steps through each element after reading the template information and ensures that any element that must be aware of a comparable element's existence is notified ( such as creator/contributor ).

public Build_Final_Adjustment_And_Checks ( ) : void
return	void

CompleteTemplate() public method

Constructor for a new instance of the CompleteTemplate class

public CompleteTemplate ( ) : System
return	System

CompleteTemplate() public method

Constructor for a new instance of the CompleteTemplate class

public CompleteTemplate ( string Name ) : System
Name	string	Name of this template
return	System

Read_XML_Template() public static method

Static method reads a template XML configuraton file and creates the CompleteTemplate object

This utilizes the Template_XML_Reader class to do the actual reading

public static Read_XML_Template ( string XmlFile ) : CompleteTemplate
XmlFile	string	Filename of the template XML configuraiton file to read
return	CompleteTemplate

Read_XML_Template() public static method

Static method reads a template XML configuraton file and creates the CompleteTemplate object

This utilizes the Template_XML_Reader class to do the actual reading

public static Read_XML_Template ( string XmlFile, bool ExcludeDivisions ) : CompleteTemplate
XmlFile	string	Filename of the template XML configuraiton file to read
ExcludeDivisions	bool	Flag indicates whether to include the structure map, if included in the template file
return	CompleteTemplate

Render_Template_HTML() public method

Displays an item as HTML using this template

public Render_Template_HTML ( TextWriter Output, SobekCM_Item Bib, string Skin_Code, bool isMozilla, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, Navigation_Object Current_Mode ) : string
Output	System.IO.TextWriter	Text writer to write all of the HTML for this template
Bib	SobekCM.Resource_Object.SobekCM_Item	Bibliographic identifier for the item to display
Skin_Code	string	Current base skin code
isMozilla	bool	Flag indicates if this is Mozilla
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
Current_Mode	SobekCM.Core.Navigation.Navigation_Object	Mode / navigation information for the current request
return	string

Render_Template_HTML() public method

Displays one page worth of elements from an item as HTML using this template

public Render_Template_HTML ( TextWriter Output, SobekCM_Item Bib, string Skin_Code, bool isMozilla, User_Object Current_User, Web_Language_Enum CurrentLanguage, Language_Support_Info Translator, string Base_URL, int page ) : string
Output	System.IO.TextWriter	Text writer to write all of the HTML for this template
Bib	SobekCM.Resource_Object.SobekCM_Item	Bibliographic identifier for the item to display
Skin_Code	string	Current base skin code
isMozilla	bool	Flag indicates if this is Mozilla
Current_User	SobekCM.Core.Users.User_Object	Current user, which can dictate how certain elements within this template render
CurrentLanguage	Web_Language_Enum	Current language of the user interface
Translator	SobekCM.Core.ApplicationState.Language_Support_Info	Language support object is used to help translate common user interface terms into the current language
Base_URL	string	Base URL for the current request
page	int	Page number to display from this template
return	string

Save_To_Bib() public method

Saves the data entered by the user through this template to the provided bibliographic object

public Save_To_Bib ( SobekCM_Item Bib, User_Object Current_User ) : void
Bib	SobekCM.Resource_Object.SobekCM_Item	Object into which to save the user-entered data
Current_User	SobekCM.Core.Users.User_Object	Current user, who's rights may impact the way an element is rendered
return	void

Save_To_Bib() public method

Saves the data entered by the user through one page of this template to the provided bibliographic object

public Save_To_Bib ( SobekCM_Item Bib, User_Object Current_User, int Page ) : void
Bib	SobekCM.Resource_Object.SobekCM_Item	Object into which to save the user-entered data
Current_User	SobekCM.Core.Users.User_Object	Current user, who's rights may impact the way an element is rendered
Page	int	Page number of the template to save
return	void