C# Class SobekCM.Core.Aggregations.Item_Aggregation

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

Private Properties

Property	Type	Description

Public Methods

Method	Description
Add_Child_Aggregation ( Item_Aggregation_Related_Aggregations Child_Aggregation ) : void	Method adds another aggregation as a child of this
Add_Child_Page ( Item_Aggregation_Child_Visibility_Enum Browse_Type, string Browse_Code, string StaticHtmlSource, string Text ) : SobekCM.Core.Aggregations.Item_Aggregation_Child_Page	Add a new browse or info object to this hierarchical object
Add_Child_Page ( SobekCM.Core.Aggregations.Item_Aggregation_Child_Page ChildPage ) : void	Add a child page to this item aggregatiion
Add_Parent_Aggregation ( Item_Aggregation_Related_Aggregations Parent_Aggregation ) : void	Method adds another aggregation as a parent to this
Add_Setting ( string Key, string Value ) : void	Add a key/value pair setting to this aggregation If a value already exists for the provided key, the value will be changed to the new value provided to this method.
Add_Web_Skin ( string Web_Skin ) : void	Add a web skin which this aggregation can appear under
Child_Page_By_Code ( string ChildCode ) : SobekCM.Core.Aggregations.Item_Aggregation_Child_Page	Get a child page by code
Contains_Browse_Info ( string Browse_Code ) : bool	Checks to see if a particular browse code exists in the list of browses or infos for this item aggregation
Get_Banner_Image ( Web_Skin_Object ThisWebSkin ) : string	Get the banner image for this aggregation, possibly returning the web skin banner if it overrides the aggregation banner
Get_Setting ( string Key ) : string	Gets a setting value, by key
Item_Aggregation ( ) : System	Constructor for a new instance of the language-specific Item_Aggregation class
Item_Aggregation ( Web_Language_Enum Language, int ID, string Code ) : System	Constructor for a new instance of the language-specific Item_Aggregation class

Method Details

Add_Child_Aggregation() public method

Method adds another aggregation as a child of this

public Add_Child_Aggregation ( Item_Aggregation_Related_Aggregations Child_Aggregation ) : void
Child_Aggregation	Item_Aggregation_Related_Aggregations	New child aggregation
return	void

Add_Child_Page() public method

Add a new browse or info object to this hierarchical object

public Add_Child_Page ( Item_Aggregation_Child_Visibility_Enum Browse_Type, string Browse_Code, string StaticHtmlSource, string Text ) : SobekCM.Core.Aggregations.Item_Aggregation_Child_Page
Browse_Type	Item_Aggregation_Child_Visibility_Enum	Flag indicates if this is a BROWSE or INFO object
Browse_Code	string	SubMode indicator for this object
StaticHtmlSource	string	Any static HTML source to be used for display
Text	string	Text to display for this browse
return	SobekCM.Core.Aggregations.Item_Aggregation_Child_Page

Add_Child_Page() public method

Add a child page to this item aggregatiion

public Add_Child_Page ( SobekCM.Core.Aggregations.Item_Aggregation_Child_Page ChildPage ) : void
ChildPage	SobekCM.Core.Aggregations.Item_Aggregation_Child_Page	New child page to add
return	void

Add_Parent_Aggregation() public method

Method adds another aggregation as a parent to this

public Add_Parent_Aggregation ( Item_Aggregation_Related_Aggregations Parent_Aggregation ) : void
Parent_Aggregation	Item_Aggregation_Related_Aggregations	New parent aggregation
return	void

Add_Setting() public method

Add a key/value pair setting to this aggregation

If a value already exists for the provided key, the value will be changed to the new value provided to this method.

public Add_Setting ( string Key, string Value ) : void
Key	string	Key for this setting
Value	string	Value for this setting
return	void

Add_Web_Skin() public method

Add a web skin which this aggregation can appear under

public Add_Web_Skin ( string Web_Skin ) : void
Web_Skin	string	Web skin this can appear under
return	void

Child_Page_By_Code() public method

Get a child page by code

public Child_Page_By_Code ( string ChildCode ) : SobekCM.Core.Aggregations.Item_Aggregation_Child_Page
ChildCode	string	Code for this child page
return	SobekCM.Core.Aggregations.Item_Aggregation_Child_Page

Contains_Browse_Info() public method

Checks to see if a particular browse code exists in the list of browses or infos for this item aggregation

public Contains_Browse_Info ( string Browse_Code ) : bool
Browse_Code	string	Code for the browse or info to check for existence
return	bool

Get_Banner_Image() public method

Get the banner image for this aggregation, possibly returning the web skin banner if it overrides the aggregation banner

public Get_Banner_Image ( Web_Skin_Object ThisWebSkin ) : string
ThisWebSkin	SobekCM.Core.Skins.Web_Skin_Object	Web skin object, which may override the banner from this aggregation
return	string

Get_Setting() public method

Gets a setting value, by key

public Get_Setting ( string Key ) : string
Key	string	Key to look for a match from the settings key/value pairs
return	string

Item_Aggregation() public method

Constructor for a new instance of the language-specific Item_Aggregation class

public Item_Aggregation ( ) : System
return	System

Item_Aggregation() public method

Constructor for a new instance of the language-specific Item_Aggregation class

public Item_Aggregation ( Web_Language_Enum Language, int ID, string Code ) : System
Language	Web_Language_Enum	Language for this language-specific version of an item aggregation
ID	int	Primary key for this item aggregation, from the database
Code	string	Aggregation code for this item aggregation
return	System