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 >> SobekCM_Assistant >> Get_Item Method >> Get_Item (String, Navigation_Object, Item_Lookup_Object, String, Dictionary(String, Wordmark_Icon), List(String), Custom_Tracer, User_Object, SobekCM_Item, Page_TreeNode, SobekCM_Items_In_Title)

SobekCM_Assistant.Get_Item Method (String, Navigation_Object, Item_Lookup_Object, String, Dictionary(String, Wordmark_Icon), List(String), Custom_Tracer, User_Object, SobekCM_Item, Page_TreeNode, SobekCM_Items_In_Title)



Get a digital resource for display or for editing


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

Syntax

C#
public bool Get_Item(
	string Collection_Code,
	Navigation_Object Current_Mode,
	Item_Lookup_Object All_Items_Lookup,
	string Base_URL,
	Dictionary<string, Wordmark_Icon> Icon_Table,
	List<string> Item_Viewer_Priority,
	Custom_Tracer Tracer,
	User_Object Current_User,
	out SobekCM_Item Current_Item,
	out Page_TreeNode Current_Page,
	out SobekCM_Items_In_Title Items_In_Title
)

Parameters

Collection_Code
Type: System..::..String
Collection code to which this item must belong
Current_Mode
Type: SobekCM.Core.Navigation..::..Navigation_Object
Mode / navigation information for the current request
All_Items_Lookup
Type: SobekCM.Engine_Library.ApplicationState..::..Item_Lookup_Object
Lookup object used to pull basic information about any item loaded into this library
Base_URL
Type: System..::..String
Base URL for all the digital resource files for items to display
Icon_Table
Type: System.Collections.Generic..::..Dictionary<(Of <(<'String, Wordmark_Icon>)>)>
Dictionary of all the wordmark/icons which can be tagged to the items
Item_Viewer_Priority
Type: System.Collections.Generic..::..List<(Of <(<'String>)>)>
List of the globally defined item viewer priorities
Tracer
Type: SobekCM.Tools..::..Custom_Tracer
Trace object keeps a list of each method executed and important milestones in rendering
Current_User
Type: SobekCM.Core.Users..::..User_Object
Currently logged on user information (used when editing an item)
Current_Item
Type: SobekCM.Resource_Object..::..SobekCM_Item%
[OUT] Built single digital resource ready for displaying or editing
Current_Page
Type: SobekCM.Resource_Object.Divisions..::..Page_TreeNode%
[OUT] Build current page for display
Items_In_Title
Type: SobekCM.Core.Items..::..SobekCM_Items_In_Title%
[OUT] List of all the items in this title

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. If the item must be built from scratch, the SobekCM_Item_Factory class is utilized.

See Also



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