CompleteTemplate Class
CompleteTemplate object stores all the information about an individual metadata template and all
of the elements contained within the panels and pages of the template
Namespace: SobekCM.Library.Citation.TemplateAssembly: SobekCM_Library (in SobekCM_Library.dll) Version: 4.10.0.0 (4.10.0.0)
Syntax
| C# |
|---|
[SerializableAttribute]
public class CompleteTemplate |
Inheritance Hierarchy
Constructors
Methods
|
| Name | Description |
|---|
 | Add_Codes | Method adds aggregation codes to the pertinent element objects ( i.e., collections, subcollecctions, etc.. ) |
| Add_Constant | Adds a new constant to the collection of constants contained within this template |
| Add_Page | Adds a new template page to the collection of pages contained within this template |
 | Build_Final_Adjustment_And_Checks | Steps through each element after reading the template information and ensures that
any element that must be aware of a comparable element's existence is notified ( such as
creator/contributor ). |
 | Read_XML_Template(String) | Static method reads a template XML configuraton file and creates the CompleteTemplate object |
| Read_XML_Template(String, Boolean) | Static method reads a template XML configuraton file and creates the CompleteTemplate object |
| Render_Template_HTML(TextWriter, SobekCM_Item, String, Boolean, User_Object, Web_Language_Enum, Language_Support_Info, Navigation_Object) | Displays an item as HTML using this template |
| Render_Template_HTML(TextWriter, SobekCM_Item, String, Boolean, User_Object, Web_Language_Enum, Language_Support_Info, String, Int32) | Displays one page worth of elements from an item as HTML using this template |
| Save_To_Bib(SobekCM_Item, User_Object) | Saves the data entered by the user through this template to the provided bibliographic object |
| Save_To_Bib(SobekCM_Item, User_Object, Int32) | Saves the data entered by the user through one page of this template to the provided bibliographic object |
Properties
|
| Name | Description |
|---|
 | Banner | Banner which overrides the default banner whenever using this template |
| BibID_Root | Root used for the Bibliographic Identifier (BibID) for new items added with this template |
| Code | Code for this template |
| Constants | Read-only collection of constant elements for this template |
| Creator | Name of the creator of this template |
| DateCreated | Date this template was created |
| Default_Visibility | Value indicates the IP restriction / visibility setting by default for items
being entered through this template |
| Email_Upon_Receipt | Email address which receives an automatic email anytime a new
item is submitted through this template |
| Include_User_As_Author | Flag indicates if the user should be marked as the default creator
with this template |
| InputPages | |
| InputPages_Count | Gets the number of input pages in this template |
| LastModified | Date this template was last modified |
| Notes | Notes about the creation and maintenance of this template |
| Permissions_Agreement | Permissions agreement for this template |
| Title | Current title of this template |
| Upload_Mandatory | Flag indicates if a new item using this template must have an upload of some type |
| Upload_Types | Indicates the types of uploads that are required with this item |
See Also
