| public Set_Header_Footer_Source ( string Header_Source, string Footer_Source, string Header_Item_Source, string Footer_Item_Source ) : void | ||
| Header_Source | string | Name for the file containing the standard header HTML |
| Footer_Source | string | Name for the file containing the standard footer HTML |
| Header_Item_Source | string | Name for the file containing the item-specific header HTML (used when displaying an item in the item viewer) |
| Footer_Item_Source | string | Name for the file containing the item-specific footer HTML (used when displaying an item in the item viewer) |
| Результат | void | |
/// <summary> Builds a language-specific <see cref="Web_Skin_Object"/> when needed by a user's request </summary>
/// <param name="CompleteSkin"> Complete web skin object </param>
/// <param name="Language_Code"> Code for the language, which determines which HTML to use </param>
/// <param name="Tracer"></param>
/// <returns> Completely built HTML interface object </returns>
/// <remarks> The datarow for this method is retrieved from the database by calling the <see cref="Database.Engine_Database.Get_All_Web_Skins"/> method during
/// application startup and is then stored in the <see cref="Web_Skin_Collection"/> class until needed. </remarks>
public static Web_Skin_Object Build_Skin(Complete_Web_Skin_Object CompleteSkin, string Language_Code, Custom_Tracer Tracer )
{
// Look for the language
Web_Language_Enum language = Web_Language_Enum_Converter.Code_To_Enum(Language_Code);
Web_Language_Enum original_language = language;
if (!CompleteSkin.SourceFiles.ContainsKey(language))
{
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Language requested ( " + Web_Language_Enum_Converter.Enum_To_Name(language) + " ) not in language list");
language = Engine_ApplicationCache_Gateway.Settings.System.Default_UI_Language;
if (( original_language == language ) || ( !CompleteSkin.SourceFiles.ContainsKey(language)))
{
if ((Tracer != null) && ( original_language != language ))
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Default UI language ( " + Web_Language_Enum_Converter.Enum_To_Name(language) + " ) not in language list");
language = Web_Language_Enum.DEFAULT;
if (!CompleteSkin.SourceFiles.ContainsKey(language))
{
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "DEFAULT language not in language list");
language = Web_Language_Enum.English;
if (!CompleteSkin.SourceFiles.ContainsKey(language))
{
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "English language also not in language list");
if (CompleteSkin.SourceFiles.Count > 0)
{
language = CompleteSkin.SourceFiles.Keys.First();
}
else
{
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Apparently there are NO source files.. returning NULL");
language = Web_Language_Enum.UNDEFINED;
}
}
}
}
}
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Will build language-specific web skin for '" + Web_Language_Enum_Converter.Enum_To_Name(language) + "'");
// Now, look in the cache for this
if (language != Web_Language_Enum.UNDEFINED)
{
Web_Skin_Object cacheObject = CachedDataManager.WebSkins.Retrieve_Skin(CompleteSkin.Skin_Code, Web_Language_Enum_Converter.Enum_To_Code(language), null);
if (cacheObject != null)
{
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Web skin found in the memory cache");
return cacheObject;
}
}
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Web skin not found in the memory cache, so building it now");
// Build this then
Web_Skin_Object returnValue = new Web_Skin_Object(CompleteSkin.Skin_Code, CompleteSkin.Base_Skin_Code, "design/skins/" + CompleteSkin.Skin_Code + "/" + CompleteSkin.CSS_Style);
// Set the language code
if ( language == Web_Language_Enum.DEFAULT )
returnValue.Language_Code = Web_Language_Enum_Converter.Enum_To_Code(Engine_ApplicationCache_Gateway.Settings.System.Default_UI_Language);
else if ( language == Web_Language_Enum.UNDEFINED )
returnValue.Language_Code = Web_Language_Enum_Converter.Enum_To_Code(language);
// Set some optional (nullable) flags
if ( CompleteSkin.Override_Banner ) returnValue.Override_Banner = true;
if ( CompleteSkin.Suppress_Top_Navigation ) returnValue.Suppress_Top_Navigation = true;
// If no suitable language was found, probably an error (no source files at all)
if (language == Web_Language_Enum.UNDEFINED)
{
if (!String.IsNullOrEmpty(CompleteSkin.Exception))
returnValue.Exception = CompleteSkin.Exception;
else
returnValue.Exception = "No valid source files found";
// Also set the headers and footers to the exception
returnValue.Header_HTML = returnValue.Exception;
returnValue.Footer_HTML = returnValue.Exception;
returnValue.Header_Item_HTML = returnValue.Exception;
returnValue.Footer_Item_HTML = returnValue.Exception;
return returnValue;
}
// Get the source file
Complete_Web_Skin_Source_Files sourceFiles = CompleteSkin.SourceFiles[language];
// Build the banner
if ((returnValue.Override_Banner.HasValue) && (returnValue.Override_Banner.Value))
{
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Skin overrides the banner, so build the banner HTML");
// Find the LANGUAGE-SPECIFIC high-bandwidth banner image
if ( !String.IsNullOrEmpty(sourceFiles.Banner))
{
if ( !String.IsNullOrEmpty(CompleteSkin.Banner_Link))
{
returnValue.Banner_HTML = "<a href=\"" + CompleteSkin.Banner_Link + "\"><img border=\"0\" src=\"<%BASEURL%>skins/" + CompleteSkin.Skin_Code + "/" + sourceFiles.Banner + "\" alt=\"MISSING BANNER\" /></a>";
}
else
{
returnValue.Banner_HTML = "<img border=\"0\" src=\"<%BASEURL%>skins/" + CompleteSkin.Skin_Code + "/" + sourceFiles.Banner + "\" alt=\"MISSING BANNER\" />";
}
}
}
// Now, set the header and footer html
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Determine the header footer source HTML files");
string this_header = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", CompleteSkin.Skin_Code, sourceFiles.Header_Source_File);
string this_footer = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", CompleteSkin.Skin_Code, sourceFiles.Footer_Source_File);
string this_item_header = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", CompleteSkin.Skin_Code, sourceFiles.Header_Item_Source_File);
string this_item_footer = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", CompleteSkin.Skin_Code, sourceFiles.Footer_Item_Source_File);
// If the item specific stuff doesn't exist, use the regular
if (!File.Exists(this_item_header))
this_item_header = this_header;
if (!File.Exists(this_item_footer))
this_item_footer = this_footer;
// Now, assign all of these
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Get the HTML source for all the headers and footers");
returnValue.Set_Header_Footer_Source(this_header, this_footer, this_item_header, this_item_footer);
if (Tracer != null) Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Returning the fully built web skin");
return returnValue;
}
