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
MISSING BANNER
Code Details >> Library >> HTML >> abstractHtmlSubwriter >> Get_Top_Level_Collection

abstractHtmlSubwriter.Get_Top_Level_Collection Method



Gets the item aggregation and search fields for the current item aggregation


Namespace: SobekCM.Library.HTML
Assembly: SobekCM_Library (in SobekCM_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
protected static bool Get_Top_Level_Collection(
	Navigation_Object Current_Mode,
	Custom_Tracer Tracer,
	out Item_Aggregation Aggregation_Object
)

Parameters

Current_Mode
Type: SobekCM.Core.Navigation..::..Navigation_Object
Mode / navigation information for the current request
Tracer
Type: SobekCM.Tools..::..Custom_Tracer
Trace object keeps a list of each method executed and important milestones in rendering
Aggregation_Object
Type: SobekCM.Core.Aggregations..::..Item_Aggregation%
[OUT] Fully-built object for the current aggregation object

Return Value

Type: Boolean
TRUE if successful, otherwise FALSE

Remarks

This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the database and hands off to the CachedDataManager to store in the cache.

See Also



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