| TmplItem Methods |
[This is preliminary documentation and is subject to change.]
The TmplItem type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Add |
Add sub-item
|
| AddComputation |
Add computation
|
| AddHistoryData |
Override this method for special handling of history representation of data.
The method is used in conjuction with AddHistoryDataDefinition. This method
is called after the AddHistoryDataDefinition method.
Use this method for adding data to a specific row.
|
| AddHistoryDataDefinition |
Override this method for special handling of history representation of data.
The method is used in conjuction with AddHistoryData. This method is called
before the AddHistoryData method.
Use this method for adding new columns to the DataTable.
|
| AddRule |
Add specified rule to rulcollection
|
| AllowChild(Type) |
Return true if childType is allowed as type of sub-item.
Override as necessary.
|
| AllowChild(TmplItem) |
Return true if child is allowed as sub-item.
Override as necessary.
|
| AttributeString |
Returns human readable attribute values (used for debug output)
|
| CheckAll(ProgressCollection, String, String) |
Check TmplItem - including sub-items - for inconsistencies
|
| CheckAll(ProgressCollection, String, String, Boolean) |
Check TmplItem - including sub-items - for inconsistencies
|
| CheckReport(ProgressCollection, String, String) |
Check TmplItem
|
| CheckReport(Boolean, ProgressCollection, String, String) |
Check TmplItem - optionally write header and footer
|
| CheckRules(FormContext, CheckRulesResult) |
Check rules (including fill-in-status) on this item and all subitems
|
| CheckRules(FormContext, MessageCollection, CheckRulesResult) |
Check rules (including fill-in-status) on this item and all subitems
|
 | CheckRules1 |
Check rules (including fill-in-status) on this element only
|
| ClearMessages |
Remove all messages
|
| ClearMessages(MessageSource) |
Remove all messages from a specific source
|
| Clone |
Implements the Clone method of the ICloneable interface. Enables deep copying of this object
as opposed to the shallow copying of MemberwiseCopy
|
| ComputeVisibility | |
| CopySubTmplItems |
Method to copy SubTmplItems from another TmplItem to this.
Default behavior is to only copy those items allowed beneath this TmplItem
Override this method if special handling is needed
|
| DataClear |
Clear data from the TmplItem
|
| DataDictionary |
DataDictionary processing for this TmplItem and all sub-items.
Maintains list of parent tables.
|
| DataDictionaryFieldAdd |
Utility method to add field to DataDictionary
|
| DataDictionaryFieldCreate(DataDictionary, DataType, Int32, ProgressCollection, String, Boolean) |
Utility method to create a DataDictionary field - not inserted in DataDictionary!
|
| DataDictionaryFieldCreate(DataDictionary, DataType, String, Int32, ProgressCollection, String, Boolean) |
Utility method to create a DataDictionary field - not inserted in DataDictionary!
|
| DataDictionaryTableCreate |
Utility method to create table in DataDictionary
|
| DataDictionaryTableFieldAdd |
Utility method to add a field to the current table
|
| DataGet |
Get data from submitted HTML form into TemplItem
|
| DataLoad |
Load data from DynamicRecord dynRec into TmplItem
|
| DataPostSave |
Called after the record is saved to facilitate various clean-up
|
| DataSave |
Save data from TmplItem into DynamicRecord dynRec |
| DebugPrint |
Print to debug listener
|
| DebugPrint(String) |
Print to debug listener
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Evaluate |
Evaluate
|
| EvaluateSpecific |
Enables sub classes to implement specific evaluation functionality
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FindByDataName |
Returns tmpItem that matches specified dataname
|
| FindByHTMLName |
Returns tmpItem that matches specified htmlname
|
| FindById |
Search the tree from this node to find a TmplItem with the given id (optionally search recusively)
|
| FindByUniqueId |
Search the tree from this node to find a TmplItem with the given UniqueId (optionally search recusively)
|
| FormInit | |
| GetArrayTableContainer |
Returns the ArrayTable that this TmplItem is contained in (null is the
TmplItem isn't contained in an array)
|
| GetCaption |
Returns Caption (= display name for forms / fields).
Override in subclasses with visible user interface elements.
|
| GetDataName |
Returns DataName (= name used for database tables / fields).
Override in subclasses with DataName property.
|
| GetDefaultChild |
Returns the default type (subclass of TmplItem) of child this object prefers
|
| GetGlobalStringResource(String) |
Gets the global string resource. Default to using 'TOPICA' as ClassKey.
|
| GetGlobalStringResource(String, String) |
Gets the global string resource.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetHistoryCaption |
Returns HistoryCaption (= history display name for fields with no caption
or where caption on form should be different from caption in history tree ).
Override in subclasses with visible user interface elements.
|
| GetLocalStringResource(String, String) |
Gets the local string resource.
|
| GetLocalStringResource(String, String, CultureInfo) |
Gets the local string resource.
|
| GetMessages |
Get all messages (recursively for entire TmplItem tree)
|
| GetPostProcess |
Get collection of currently selected post-processing commands
|
| GetPreProcess |
Collect pre-processing commands recursively (for alle visible elements)
|
| GetSubItemsByType |
Get all subitems with a specified type
|
 | GetTemplateCacheKey |
Gets the template cache key.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HTMLFormName |
Returns the HTML name of the form tag
|
| HTMLWrite |
Write HTML: whole TmplItem (caption and control inside span tag)
|
| IncludeCount |
Get # of Include-items (used to decide whether include-resolving is necessary)
|
| InsertAfter |
Insert ti after this TmplItem
|
| InsertBefore |
Insert ti before this TmplItem
|
| JavaScriptFocus | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MergeInclude |
Merge merge in place of first include item
|
| NewTmplItem(String) |
Construct new TmplItem by type name
|
| NewTmplItem(XmlNode) |
Construct new TmplItem by type name from XmlNode name
|
| NumberString |
Set number strings
|
| OnPreRender |
Do some postprocesseing immediately after the form HTML has been generated.
Note that the page is not fully generated at this point.
If you need to do some processing after the page has been fulle rendered, use OnPreRenderComplete
|
| OnPreRenderComplete |
Do some postprocesseing immediately after the whole page has been generated.
|
| Renumber |
Renumber id 1, 2, 3, ... in whole hierarchy (depth first)
|
| Renumber(Int32) |
Renumber id in hierarchy (depth first)
|
| SetComputation(String, String) |
Set commputation with name and expression expr |
| SetComputation(DataDictionaryComputationName, String) |
Set commputation with name and expression expr |
| SetCustomPropertiesOnDataDictionaryTable |
Override this method to set properties on the DataDictionarytable that isn't defined on TmplItem but instead
on a TmplItem inherited class. This default implementation does nothing
|
| SetDefault |
Set default value
|
| SetFromPreProcessed |
Override this method to set data of the template item from the pre processed data
|
| Top |
Get the top item.
|
| ToString |
For debugging
(Overrides ObjectToString.) |
| UseCaching |
Indicates if caching is available.
|
| WriteStructure |
Write hierarchical structure of this TmplItem and sub-items
|
| XMLLoad |
Load attributes and subelements from node, optionally resolving includes
|
| XMLReadFile(Boolean, String) |
Read TmplItem from XML file
|
| XMLReadFile(Stream, Boolean) |
Read XMLfile into tmpItem
|
| XMLReadFile(StreamReader, Boolean, String) |
Read TmplItem from streamReader |
| XMLReadFile(String, DataDictionaryTable, Boolean) |
Read TmplItem from XML file
|
| XMLReadFile(String, Boolean, Cache, String, FormContext) |
Read TmplItem form XML file
|
| XMLReadFile(String, DataDictionaryTable, Boolean, Cache, String, FormContext) |
Read TmplItem from XML file
|
| XMLWrite(XmlTextWriter) |
Write TmplItem - (including sub-items) to XML file
|
| XMLWrite(String, Encoding) |
Write TmplItem - including sub-items - to XML file
|
| XMLWrite(XmlTextWriter, Boolean) |
Write TmplItem - (including sub-items) to XML file
|
| XMLWrite(Stream, Encoding, Boolean) |
Write TmplItem - including sub-items - to |
| XMLWrite(String, Encoding, Boolean) |
Write TmplItem - including sub-items - to XML file
|
| XMLWrite(Stream, Encoding, Boolean, Boolean) |
Write TmplItem - including sub-items - to |
See Also