mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='https://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='https://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='https://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='https://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='https://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
Expand <a href='https://sobekrepository.org/codehelp/engineagnosticlayerdbaccess' title='EngineAgnosticLayerDbAccess'>EngineAgnosticLayerDbAccess Namespace</a>EngineAgnosticLayerDbAccess Namespace
Expand <a href='https://sobekrepository.org/codehelp/builder_library' title='SobekCM.Builder_Library'>Builder_Library Namespace</a>Builder_Library Namespace
Collapse <a href='https://sobekrepository.org/codehelp/core' title='SobekCM.Core'>Core Namespace</a>Core Namespace
Expand <a href='https://sobekrepository.org/codehelp/engine_library' title='SobekCM.Engine_Library'>Engine_Library Namespace</a>Engine_Library Namespace
Expand <a href='https://sobekrepository.org/codehelp/library' title='SobekCM.Library'>Library Namespace</a>Library Namespace
Expand <a href='https://sobekrepository.org/codehelp/resource_object' title='SobekCM.Resource_Object'>Resource_Object Namespace</a>Resource_Object Namespace
Expand <a href='https://sobekrepository.org/codehelp/tools' title='SobekCM.Tools'>Tools Namespace</a>Tools Namespace
MISSING BANNER
Code Details >> Core >> Aggregations >> Item_Aggregation

Item_Aggregation Class



Language-specific item aggregation data


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

Syntax

C#
[SerializableAttribute]
[ProtoContractAttribute]
[XmlRootAttribute("aggregation")]
[DataContractAttribute]
public class Item_Aggregation

Inheritance Hierarchy

System..::..Object
  SobekCM.Core.Aggregations..::..Item_Aggregation

Constructors

  NameDescription
Public methodItem_Aggregation()()()()
Constructor for a new instance of the language-specific Item_Aggregation class
Public methodItem_Aggregation(Web_Language_Enum, Int32, String)
Constructor for a new instance of the language-specific Item_Aggregation class

Methods

  NameDescription
Public methodAdd_Child_Aggregation
Method adds another aggregation as a child of this
Public methodAdd_Child_Page(Item_Aggregation_Child_Page)
Add a child page to this item aggregatiion
Public methodAdd_Child_Page(Item_Aggregation_Child_Visibility_Enum, String, String, String)
Add a new browse or info object to this hierarchical object
Public methodAdd_Parent_Aggregation
Method adds another aggregation as a parent to this
Public methodAdd_Web_Skin
Add a web skin which this aggregation can appear under
Public methodChild_Page_By_Code
Get a child page by code
Public methodContains_Browse_Info
Checks to see if a particular browse code exists in the list of browses or infos for this item aggregation
Public methodGet_Banner_Image
Get the banner image for this aggregation, possibly returning the web skin banner if it overrides the aggregation banner

Fields

  NameDescription
Public fieldCustom_Directives
List of custom directives used within this aggregation to replicate a large chunk of HTML on multiple static browse pages

Properties

  NameDescription
Public propertyActive
Flag indicating this item aggregation is active
Public propertyBannerImage
Filename for the banner used on most of the aggregation pages, and perhaps the front page as well
Public propertyBrowse_By_Pages
Read-only list of all the browse objects to appear under the BROWSE BY attached to this item aggregation
Public propertyBrowse_Home_Pages
Read-only list of all the browse objects to appear on the home page attached to this item aggregation
Public propertyBrowse_Info_Count
Gets the number of browses and info pages attached to this item aggregation
Public propertyBrowseable_Fields
Returns the list of the primary identifiers for all metadata fields which have data and thus could appear in the metadata browse
Public propertyCan_Browse_Items
Flag indicates if this aggregation can potentially include the ALL ITEMS and NEW ITEMS tabs
Public propertyChild_Pages
Collection of all child pages
Public propertyChild_Types
The common type of all child collections, or the default
Public propertyChildren
Gets the read-only collection of children item aggregation objects
Public propertyChildren_Count
Gets the number of child item aggregationPermissions present
Public propertyCode
Code for this item aggregation object
Public propertyContact_Email
Contact email for any correspondance regarding this item aggregation
Public propertyContactForm
Any aggregation-specific contact form configuration, otherwise NULL
Public propertyCSS_File
Aggregation-level CSS file, if one exists
Public propertyCustom_Home_Page
Custom home page source file, if one exists
Public propertyDefault_BrowseBy
Default browse by code, if no code is provided in the request
Public propertyDefault_Result_View
Gets the default results view mode for this item aggregation
Public propertyDefault_Skin
Default interface to be used for this item aggregation
Public propertyDescription
Description of this item aggregation (in the default language )
Public propertyDisplay_Options
Display options string for this item aggregation
Public propertyFacets
Returns the list of all facets to display during searches and browses within this aggregation
Public propertyFrontBannerObj
Front banner information, used for the banner on the main home page of this aggregation
Public propertyHas_Browse_By_Pages
Flag indicates if this item aggregation has at least one BROWSE BY page to display
Public propertyHas_New_Items
Flag indicates if new items have recently been added to this collection which requires additional collection-level work
Public propertyHidden
Flag indicating this item aggregation is hidden from most displays
Public propertyHighlights
Gets the list of highlights associated with this item
Public propertyHomePageHtml
Information pulled from the home page source file, including the full home page text
Public propertyHomePageSource
Source file for the home page text
Public propertyID
ID for this item aggregation object
Public propertyInfo_Pages
Read-only list of all the info objects attached to this item aggregation
Public propertyLanguage
Language this item aggregation represents
Public propertyLast_Item_Added
Date the last item was added to this collection
Public propertyMap_Browse_Display
Default map display information ( i.e., center and zoom of map ) for doing a map browse within the aggregation
Public propertyMap_Display_Beta
Flag that tells what type of map display to show for this item aggregation
Public propertyMap_Search_Beta
Flag that tells what type of map searching to allow for this item aggregation
Public propertyMap_Search_Display
Default map display information ( i.e., center and zoom of map ) for doing a map search within the aggregation
Public propertyName
Full name of this item aggregation
Public propertyObjDirectory
Directory where all design information for this object is found
Public propertyParent_Codes
Returns the list of all parent codes to this aggregation, seperate by a semi-colon
Public propertyParent_Count
Gets the number of parent item aggregationPermissions present
Public propertyParents
Gets the read-only collection of parent item aggregation objects
Public propertyResult_Views
Gets the list of all result views present in this item aggregation
Public propertyRotating_Highlights
Value indicates if the highlights should be rotating through a number of highlights, or be fixed on a single highlight
Public propertyRotating_Highlights_AsString
Value indicates if the highlights should be rotating through a number of highlights, or be fixed on a single highlight
Public propertySearch_Fields
Returns the list of the primary identifiers for all metadata fields which have data and thus should appear in the advanced search drop downs
Public propertySearch_Types
Read-only list of searches types for this item aggregation
Public propertyShortName
Short name of this item aggregation
Public propertyShow_New_Item_Browse
Flag indicates if this aggregation has had any changes over the last two weeks
Public propertyStatistics
Statistical information about this aggregation ( i.e., item, title, and page count )
Public propertyType
Type of item aggregation object
Public propertyViews_And_Searches
Read-only list of collection views and searches for this item aggregation
Public propertyWeb_Skins
Gets the list of web skins this aggregation can appear under

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )