Web_Skin_Object Class

Stores information about an HTML skin, which determines the header, footer, stylesheet, and other design elements for the rendered HTML

Namespace: SobekCM.Core.Skins
Assembly: SobekCM_Core (in SobekCM_Core.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
[SerializableAttribute] [ProtoContractAttribute] [XmlRootAttribute("webSkin")] [DataContractAttribute] public class Web_Skin_Object

Remarks

This class and concept allows the same pages in this digital library to appear branded in different ways. It allows the rendered html to be altered to match a partner's institutional web pages as well.

Since this class holds the header, footer, and banner information, this HTML skin object is language-specific.

Inheritance Hierarchy

System..::..Object
SobekCM.Core.Skins..::..Web_Skin_Object

Constructors

	Name	Description
	Web_Skin_Object()()()()	Constructor for a new instance of the Web_Skin_Object class
	Web_Skin_Object(String, String, String)	Constructor for a new instance of the Web_Skin_Object class
	Web_Skin_Object(String, String, String, String)	Constructor for a new instance of the Web_Skin_Object class

Methods

	Name	Description
	Set_Header_Footer_HTML(String, String)	Method sets the header and footer to be used by this HTML skin
	Set_Header_Footer_HTML(String, String, String, String)	Method sets the header and footer to be used by this HTML skin
	Set_Header_Footer_Source	Method sets the header and footer by passing in the names for the source files containing the HTML for the headers and footers
	ShouldSerializeFooter_Has_Container_Directive	Method suppresses XML Serialization of the Footer_Has_Container_Directive property if it is NULL
	ShouldSerializeHeader_Has_Container_Directive	Method suppresses XML Serialization of the Header_Has_Container_Directive property if it is NULL
	ShouldSerializeOverride_Banner	Method suppresses XML Serialization of the Override_Banner property if it is NULL
	ShouldSerializeSuppress_Top_Navigation	Method suppresses XML Serialization of the Suppress_Top_Navigation property if it is NULL

Properties

	Name	Description
	Banner_HTML	Code for the banner to use, if this is set to override the banner
	Base_Skin_Code	Code for the base skin which this skin derives from
	CSS_Style	Additional CSS Stylesheet to be included for this skin
	Exception	Exception message, if an exception occurred whie this was built
	Footer_Has_Container_Directive	Flag indicates if the main footer has a %CONTAINER% directive indicating where the container tag should be placed. This is useful if either the whole footer, or a portion of the footer, should extend past the main container.
	Footer_HTML	HTML for the standard footer, to be included when rendering an HTML page
	Footer_Item_HTML	HTML for the item-specific footer, to be included when rendering an HTML page from the item viewer
	Header_Has_Container_Directive	Flag indicates if the main header has a %CONTAINER% directive indicating where the container tag should be placed. This is useful if either the whole header, or a portion of the header, should extend past the main container.
	Header_HTML	HTML for the standard header, to be included when rendering an HTML page
	Header_Item_HTML	HTML for the item-specific header, to be included when rendering an HTML page from the item viewer
	Language_Code	Language code, which indicates which language this skin information pertains to
	Override_Banner	Flag indicates if this skin has a banner which should override any aggregation-specific banner
	Skin_Code	Code for this skin
	Suppress_Top_Navigation	Flag indicates if the top-level aggregation navigation should be suppressed for this web skin ( i.e., is the top-level navigation embedded into the header file already? )