C# Class SobekCM.Core.Aggregations.Complete_Item_Aggregation_Child_Page

Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property Type Description
Write_In_Configuration_XML_File void

Public Methods

Method Description
Add_Label ( string Label, Web_Language_Enum Language ) : void

Add the label for this browse/info object, by language

Add_Static_HTML_Source ( string HTML_Source, Web_Language_Enum Language ) : void

Add the label for this browse/info object, by language

Complete_Item_Aggregation_Child_Page ( ) : System

Constructor for a new instance of the Item_Aggregation_Complete_Child_Page class

Complete_Item_Aggregation_Child_Page ( Item_Aggregation_Child_Visibility_Enum Browse_Type, Item_Aggregation_Child_Source_Data_Enum Source_Data_Type, string Code, string Static_HTML_Source, string Label ) : System

Constructor for a new instance of the Item_Aggregation_Complete_Child_Page class

Get_Label ( Web_Language_Enum Language ) : string

Gets the language-specific label, if one exists

Get_Static_Content ( Web_Language_Enum Language, string Base_URL, string Base_Network, Custom_Tracer Tracer ) : HTML_Based_Content

Gets the static HTML_based content associated with this browse/info file (if it is TEXT type )

This actually reads the HTML file each time this is requested

Get_Static_HTML_Source ( Web_Language_Enum Language ) : string

Gets the language-specific static HTML source file, if one exists

Remove_Language ( Web_Language_Enum Language_To_Remove ) : void

Removes a language from this child page's dictionaries of labels/titles and source files

Private Methods

Method Description
Write_In_Configuration_XML_File ( StreamWriter Writer, string Default_BrowseBy ) : void

Method Details

Add_Label() public method

Add the label for this browse/info object, by language
public Add_Label ( string Label, Web_Language_Enum Language ) : void
Label string Label for this browse/info object
Language Web_Language_Enum Language code
return void

Add_Static_HTML_Source() public method

Add the label for this browse/info object, by language
public Add_Static_HTML_Source ( string HTML_Source, Web_Language_Enum Language ) : void
HTML_Source string Label for this browse/info object
Language Web_Language_Enum Language code
return void

Complete_Item_Aggregation_Child_Page() public method

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

Complete_Item_Aggregation_Child_Page() public method

Constructor for a new instance of the Item_Aggregation_Complete_Child_Page class
public Complete_Item_Aggregation_Child_Page ( Item_Aggregation_Child_Visibility_Enum Browse_Type, Item_Aggregation_Child_Source_Data_Enum Source_Data_Type, string Code, string Static_HTML_Source, string Label ) : System
Browse_Type Item_Aggregation_Child_Visibility_Enum Flag indicates if this is a browse by, browse, or info page
Source_Data_Type Item_Aggregation_Child_Source_Data_Enum Source and data type of this browse or info page
Code string Code for this info or browse page
Static_HTML_Source string Filename of the static source file for this browse or info page
Label string Label for this browse or info page which will be displayed on the navigation tab
return System

Get_Label() public method

Gets the language-specific label, if one exists
public Get_Label ( Web_Language_Enum Language ) : string
Language Web_Language_Enum Language of the label to retrieve
return string

Get_Static_Content() public method

Gets the static HTML_based content associated with this browse/info file (if it is TEXT type )
This actually reads the HTML file each time this is requested
public Get_Static_Content ( Web_Language_Enum Language, string Base_URL, string Base_Network, Custom_Tracer Tracer ) : HTML_Based_Content
Language Web_Language_Enum Language of the static-html request, used to find the appropriate source file
Base_URL string Currently used Base URL to reach this system
Base_Network string Base network location from which this static content would be located from
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Core.WebContent.HTML_Based_Content

Get_Static_HTML_Source() public method

Gets the language-specific static HTML source file, if one exists
public Get_Static_HTML_Source ( Web_Language_Enum Language ) : string
Language Web_Language_Enum Language of the static HTML source file to retrieve
return string

Remove_Language() public method

Removes a language from this child page's dictionaries of labels/titles and source files
public Remove_Language ( Web_Language_Enum Language_To_Remove ) : void
Language_To_Remove Web_Language_Enum
return void