Click or drag to resize
StructureElement Class

[This is preliminary documentation and is subject to change.]

A StructureElement associates a form with a database table, and thus generates a node in the the hierarchcal data model. Such a node may - in clinical terms - be called period of care, encounter, standard plan, whatever
Inheritance Hierarchy

Namespace: CSC.SC.TOPICA4.Template
Assembly: CSC.SC.TOPICA4.Template (in CSC.SC.TOPICA4.Template.dll) Version: 4.30.6239.27196
Syntax
C#
public class StructureElement : StructureBase

The StructureElement type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAdd
Add sub-item
(Inherited from TmplItem.)
Public methodAddComputation
Add computation
(Inherited from TmplItem.)
Public methodAddHistoryData
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.
(Inherited from TmplItem.)
Public methodAddHistoryDataDefinition
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.
(Inherited from TmplItem.)
Public methodAddRule
Add specified rule to rulcollection
(Inherited from TmplItem.)
Public methodAllowChild(Type)
Allow as child StructureElement or StructureReference
(Overrides TmplItemAllowChild(Type).)
Public methodAllowChild(TmplItem)
Allow as child only other StructureElements
(Overrides TmplItemAllowChild(TmplItem).)
Public methodAttributeString
Returns Attributestring
(Overrides StructureBaseAttributeString.)
Public methodCheckAll(ProgressCollection, String, String)
Check TmplItem - including sub-items - for inconsistencies
(Inherited from TmplItem.)
Public methodCheckAll(ProgressCollection, String, String, Boolean)
Check TmplItem - including sub-items - for inconsistencies
(Inherited from TmplItem.)
Public methodCheckReport(ProgressCollection, String, String)
Check TmplItem
(Inherited from TmplItem.)
Public methodCheckReport(Boolean, ProgressCollection, String, String)
Check TmplItem - optionally write header and footer
(Inherited from TmplItem.)
Public methodCheckRules(FormContext, CheckRulesResult)
Check rules (including fill-in-status) on this item and all subitems
(Inherited from TmplItem.)
Public methodCheckRules(FormContext, MessageCollection, CheckRulesResult)
Check rules (including fill-in-status) on this item and all subitems
(Inherited from TmplItem.)
Protected methodCheckRules1
Check rules (including fill-in-status) on this element only
(Inherited from TmplItem.)
Public methodClearMessages
Remove all messages
(Inherited from TmplItem.)
Public methodClearMessages(MessageSource)
Remove all messages from a specific source
(Inherited from TmplItem.)
Public methodClone
Implements the Clone method of the ICloneable interface. Enables deep copying of this object as opposed to the shallow copying of MemberwiseCopy
(Inherited from TmplItem.)
Public methodComputeVisibility
(Inherited from TmplItem.)
Protected methodCopySubTmplItems
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
(Inherited from TmplItem.)
Public methodDataClear
Clear data from the TmplItem
(Inherited from TmplItem.)
Public methodDataDictionary
DataDictionary processing for this TmplItem and all sub-items. Maintains list of parent tables.
(Inherited from TmplItem.)
Protected methodDataDictionaryFieldAdd
Utility method to add field to DataDictionary
(Inherited from TmplItem.)
Protected methodDataDictionaryFieldCreate(DataDictionary, DataType, Int32, ProgressCollection, String, Boolean)
Utility method to create a DataDictionary field - not inserted in DataDictionary!
(Inherited from TmplItem.)
Protected methodDataDictionaryFieldCreate(DataDictionary, DataType, String, Int32, ProgressCollection, String, Boolean)
Utility method to create a DataDictionary field - not inserted in DataDictionary!
(Inherited from TmplItem.)
Protected methodDataDictionaryTableCreate
Utility method to create table in DataDictionary
(Inherited from TmplItem.)
Protected methodDataDictionaryTableFieldAdd
Utility method to add a field to the current table
(Inherited from TmplItem.)
Public methodDataGet
Get data from submitted HTML form into TemplItem
(Inherited from TmplItem.)
Public methodDataLoad
Load data from DynamicRecord dynRec into TmplItem
(Inherited from TmplItem.)
Public methodDataPostSave
Called after the record is saved to facilitate various clean-up
(Inherited from TmplItem.)
Public methodDataSave
Save data from TmplItem into DynamicRecord dynRec
(Inherited from TmplItem.)
Public methodDebugPrint
Print to debug listener
(Inherited from TmplItem.)
Public methodDebugPrint(String)
Print to debug listener
(Inherited from TmplItem.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluate
Evaluate
(Inherited from TmplItem.)
Public methodEvaluateSpecific
Enables sub classes to implement specific evaluation functionality
(Inherited from TmplItem.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindByDataName
Returns tmpItem that matches specified dataname
(Inherited from TmplItem.)
Public methodFindByHTMLName
Returns tmpItem that matches specified htmlname
(Inherited from TmplItem.)
Public methodFindById
Search the tree from this node to find a TmplItem with the given id (optionally search recusively)
(Inherited from TmplItem.)
Public methodFindByUniqueId
Search the tree from this node to find a TmplItem with the given UniqueId (optionally search recusively)
(Inherited from TmplItem.)
Public methodFormInit (Inherited from TmplItem.)
Public methodGetActualHistoryCaption
Returns a Caption for displaying in the history tree
(Inherited from DataNameBase.)
Public methodGetArrayTableContainer
Returns the ArrayTable that this TmplItem is contained in (null is the TmplItem isn't contained in an array)
(Inherited from TmplItem.)
Public methodGetCaption
Gets Caption
(Inherited from CaptionBase.)
Public methodGetDataName
Returns dataname
(Inherited from DataNameBase.)
Public methodGetDefaultChild
Returns the default type (subclass of TmplItem) of child this object prefers
(Inherited from TmplItem.)
Protected methodGetFillInStatus
Get the fill in status of this template item
(Inherited from DataNameBase.)
Public methodGetGlobalStringResource(String)
Gets the global string resource. Default to using 'TOPICA' as ClassKey.
(Inherited from TmplItem.)
Public methodGetGlobalStringResource(String, String)
Gets the global string resource.
(Inherited from TmplItem.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetHistoryCaption
Gets Caption
(Inherited from CaptionBase.)
Public methodGetLocalStringResource(String, String)
Gets the local string resource.
(Inherited from TmplItem.)
Public methodGetLocalStringResource(String, String, CultureInfo)
Gets the local string resource.
(Inherited from TmplItem.)
Public methodGetMessages
Get all messages (recursively for entire TmplItem tree)
(Inherited from TmplItem.)
Public methodGetPostProcess
Get collection of currently selected post-processing commands
(Inherited from TmplItem.)
Public methodGetPreProcess
Collect pre-processing commands recursively (for alle visible elements)
(Inherited from TmplItem.)
Protected methodGetPreProcessedValue
Get value of attribute addressed by Xpath expression in PreProcessInstruction
(Inherited from DataNameBase.)
Public methodGetSubItemsByType
Get all subitems with a specified type
(Inherited from TmplItem.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHTMLFormName
Returns the HTML name of the form tag
(Inherited from TmplItem.)
Public methodHTMLWrite
Write HTML: whole TmplItem (caption and control inside span tag)
(Inherited from TmplItem.)
Public methodIncludeCount
Get # of Include-items (used to decide whether include-resolving is necessary)
(Inherited from TmplItem.)
Public methodInsertAfter
Insert ti after this TmplItem
(Inherited from TmplItem.)
Public methodInsertBefore
Insert ti before this TmplItem
(Inherited from TmplItem.)
Public methodJavaScriptFocus
(Inherited from TmplItem.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMergeInclude
Merge merge in place of first include item
(Inherited from TmplItem.)
Public methodNumberString
Set number strings
(Inherited from TmplItem.)
Public methodOnPreRender
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
(Inherited from TmplItem.)
Public methodOnPreRenderComplete
Do some postprocesseing immediately after the whole page has been generated.
(Inherited from TmplItem.)
Public methodRenumber
Renumber id 1, 2, 3, ... in whole hierarchy (depth first)
(Inherited from TmplItem.)
Public methodRenumber(Int32)
Renumber id in hierarchy (depth first)
(Inherited from TmplItem.)
Protected methodSetComputation(String, String)
Set commputation with name and expression expr
(Inherited from TmplItem.)
Protected methodSetComputation(DataDictionaryComputationName, String)
Set commputation with name and expression expr
(Inherited from TmplItem.)
Protected methodSetCustomPropertiesOnDataDictionaryTable
Set custom properties to specified datadictonary table
(Overrides TmplItemSetCustomPropertiesOnDataDictionaryTable(DataDictionaryTable).)
Public methodSetDefault
Set default value
(Inherited from TmplItem.)
Protected methodSetFromPreProcessed
Override this method to set data of the template item from the pre processed data
(Inherited from TmplItem.)
Public methodTop
Get the top item.
(Inherited from TmplItem.)
Public methodToString
For debugging
(Inherited from TmplItem.)
Public methodWriteStructure
Write hierarchical structure of this TmplItem and sub-items
(Inherited from TmplItem.)
Public methodXMLLoad
Load attributes and subelements from node, optionally resolving includes
(Inherited from TmplItem.)
Public methodXMLWrite(XmlTextWriter)
Write TmplItem - (including sub-items) to XML file
(Inherited from TmplItem.)
Public methodXMLWrite(String, Encoding)
Write TmplItem - including sub-items - to XML file
(Inherited from TmplItem.)
Public methodXMLWrite(XmlTextWriter, Boolean)
Write TmplItem - (including sub-items) to XML file
(Inherited from TmplItem.)
Public methodXMLWrite(Stream, Encoding, Boolean)
Write TmplItem - including sub-items - to
(Inherited from TmplItem.)
Public methodXMLWrite(String, Encoding, Boolean)
Write TmplItem - including sub-items - to XML file
(Inherited from TmplItem.)
Public methodXMLWrite(Stream, Encoding, Boolean, Boolean)
Write TmplItem - including sub-items - to
(Inherited from TmplItem.)
Top
Fields
  NameDescription
Public fieldAccessModeDenied
Handling of denied read access
(Inherited from StructureBase.)
Public fieldAccessModeRead
Access control mode for read
(Inherited from StructureBase.)
Public fieldAccessModeWrite
Access control mode for write
(Inherited from StructureBase.)
Public fieldAllowCascadeDelete
Expression to allow "cascade delete" - default: true
Public fieldAllowCopy
Expression to allow copy - default: false
Public fieldAllowCreate
Expression to allow create - default: true
Public fieldAllowDelete
Expression to allow delete - default: true
Public fieldAllowMerge
Expression to allow merge - default: false
Public fieldAllowMove
Expression to allow move - default: false
Public fieldAllowRead
Expression to allow read - default: true
Public fieldAllowUpdate
Expression to allow update - default: true
Public fieldApprove
Force approval
Public fieldAugmentedView
Generate "augmented" view
Public fieldAutoCreate
Records for the form corresponding to this StructureElement should be created automatically when creating a new patient (Only works for StructureElements that have a 1:1 relationship to the parent StrucureElement)
Public fieldCaption
Field label etc. displayed in data entry form
(Inherited from CaptionBase.)
Public fieldCardinality
Cardinality (1:1 or 1:N)
Public fieldClassNameControl
Stylesheet classname for control
(Inherited from TmplItem.)
Public fieldClassNameControlCell
Stylesheet classname for table cell containing control
(Inherited from TmplItem.)
Public fieldClassNameLabel
Stylesheet classname for label
(Inherited from TmplItem.)
Public fieldClassNameLabelCell
Stylesheet classname for table cell containing label
(Inherited from TmplItem.)
Public fieldClearOnCopy
This TmplItem will be cleared when copying
(Inherited from TmplItem.)
Public fieldClosable
Enable closing.
Public fieldComment
Internal comment for use by designer
(Inherited from TmplItem.)
Public fieldComputation
Expression that computes default value for field
(Inherited from DataNameBase.)
Public fieldConvertInfo
Misc. conversion info.
(Inherited from TmplItem.)
Public fieldCreateOrgUnitList
Generate one create command for each possible data owner (OrgUnit that may "own" instances of this type). Only works for 1:N cardinality and when OrgUnitRelation=Select.
Public fieldDataName
Name of table / field in data base
(Inherited from DataNameBase.)
Public fieldDefaultLastPrevious
True => field default value is set to last previous value
(Inherited from DataNameBase.)
Public fieldDefaultLastPreviousPrompt
Prompt for copying default data from previous record.
Public fieldDefaultLastPreviousSource
Source of "last previous" default data, e.g. specifies from shre to copy values.
Public fieldDeleted
TmplItem (and anything below it) is skipped when generating DataDictionary, so fields will not be generated in database.
(Inherited from TmplItem.)
Public fieldDescription
Textual description of field definition, use, etc.
(Inherited from DataNameBase.)
Public fieldDisplayAtTop
Objects are always displayed in the top of the hierarchy (i.e. not sorted)
Public fieldDisplayDate
Expression to compute display date
Public fieldDisplayName
Expression to compute display name
Public fieldExcludeFromPrint
The TmplItem is excluded from the printed version of the form
(Inherited from TmplItem.)
Public fieldFillInStatusComputation
Specifies how empty field is treated
(Inherited from DataNameBase.)
Public fieldFillInStatusSelect
Specifies how empty field is treated
(Inherited from DataNameBase.)
Public fieldFlatView
Generate "flat" view
Public fieldFormFilename
Name of referenced file
Public fieldHidden
Hidden fields generate fields in DataDictionary (and hence database), but are not visible in input form.
(Inherited from TmplItem.)
Public fieldHistoryCaption
Field label displayed in history tree (
(Inherited from CaptionBase.)
Public fieldHTMLName
Field name in generated HTML form (blank: use DataName)
(Inherited from CaptionBase.)
Public fieldImageFile
Image file
(Inherited from StructureBase.)
Public fieldLink
Reference (e.g. URL) to field definition
(Inherited from DataNameBase.)
Public fieldListColumn
Columns in automatically generated list views are sorted by this value.
(Inherited from DataNameBase.)
Public fieldMapToExternalField
Corresponding field name in som external system - used for mapping during import/export
(Inherited from DataNameBase.)
Public fieldMergeByFieldName
If set, use this field for merging: - get value of this field - lookup existing record having same value - if lookup record found, use it in further merge of subrecords, - otherwise create new record (by copying source record).
Public fieldMergeNewestFieldName
In case of merge conflict (e.g. 1:1 relation on destination patient already contains record), and merge conflict handling status (ConflictSurvivor) is "newest", the field specified in this property is used to determine which record is newest. Default value: use "lasted touched" date/time (create or updated date/time). When specified the value must refer to a DateTime field in the current table!
Public fieldMergePatientLevel
When merging with lookup by field name MergeByFieldName, default behavior is to look up only in current parent record. Set this property to true to lookup in all records (in requested table) on patient.
Public fieldNumber
Should this field be numbered
(Inherited from CaptionBase.)
Public fieldOnBlur
Custom script for onblur-event
(Inherited from TmplItem.)
Public fieldOnChange
Custom script for onchange-event
(Inherited from TmplItem.)
Public fieldOnClick
Custom script for onclick-event
(Inherited from TmplItem.)
Public fieldOnFocus
Custom script for onfocus-event
(Inherited from TmplItem.)
Public fieldOnKeyDown
Custom script for onkeydown-event
(Inherited from TmplItem.)
Public fieldOnKeyPress
Custom script for onkeypress-event
(Inherited from TmplItem.)
Public fieldOnKeyUp
Custom script for onkeyup-event
(Inherited from TmplItem.)
Public fieldOrgUnitConfigure
true iff this type of objects may be configured for individual org.units
Public fieldOrgUnitRelation
Type of relation between records and org.unit (data owner)
Public fieldPatientAccessMode
What access is allowed on this structure when logged in as patient
(Inherited from StructureBase.)
Public fieldPlan
Allow planning
Public fieldPostProcess
Code (e.g. .aspx) to execute on save
(Inherited from TmplItem.)
Public fieldPreProcess
Code (e.g. .aspx) to execute on load
(Inherited from TmplItem.)
Public fieldPreProcessInstruction
XPath expression to find values in preprocessed xml (MUST address an attribute)
(Inherited from DataNameBase.)
Public fieldPublishChanges
If true, the control is registered as a publisher, which means other controls can subscribe to changes on this control
(Inherited from DataNameBase.)
Public fieldReadFromFile
The disk file this TmplItem was read from
(Inherited from TmplItem.)
Public fieldReadOnly
Read only expression - if expression evaluates true, field may not be edited
(Inherited from DataNameBase.)
Public fieldRunPreProcessInstructionOnEdit
Normally the PreProcessInstruction is only run on when creating a new form, set this attribute to also run the instruction when editing the form
(Inherited from DataNameBase.)
Public fieldSearch
Enable search by record ID etc.
Public fieldSetValueOnCopy
Expression to set value on new recod in copy operation. If not set, dfeautl beavior is to copy the value from the source record. If set, evaluet expression, and set evaluated value on copy.
(Inherited from DataNameBase.)
Public fieldSingleOpenMode
Only 1 open record. Only relevant when Closable == true.
Public fieldSortByField
Field to sort by
(Inherited from StructureBase.)
Public fieldSortDescending
Sort direction
(Inherited from StructureBase.)
Public fieldStructureType
Type that must be defined by configurator (classification of tables)
Public fieldStyleControl
Inline style for control
(Inherited from TmplItem.)
Public fieldStyleControlCell
Inline style for table cell containing control
(Inherited from TmplItem.)
Public fieldStyleLabel
Inline style for label
(Inherited from TmplItem.)
Public fieldStyleLabelCell
Inline style for table cell containng label
(Inherited from TmplItem.)
Protected fieldsubTmplItems
tmpItemcollection
(Inherited from TmplItem.)
Public fieldTooltip
Tooltip
(Inherited from CaptionBase.)
Public fieldTooltipComputation
Expression to compute tooltip value
(Inherited from CaptionBase.)
Public fieldURLHelp
URL with help etc. for this field
(Inherited from CaptionBase.)
Public fieldViewName
Name of table / field in autogenerated views (optional - defaults to DataName)
(Inherited from DataNameBase.)
Public fieldVisibleComputation
Computation (formula) controlling visibility of item - true => item is visible
(Inherited from TmplItem.)
Top
Properties
  NameDescription
Public propertyComputations
Get the DataDictionaryComputationCollection from the TmplItem
(Inherited from TmplItem.)
Public propertyCustomQueries
Get collection of custom queries
Public propertyFocusId
Return id for the HTML element to focus
(Inherited from TmplItem.)
Public propertyFocusSelect
Return whether a focused element may be selected (e.g. whether .select() should be called)
(Inherited from TmplItem.)
Public propertyId
get/set ID
(Inherited from TmplItem.)
Protected propertyIdOfFieldToReceiveFocus
Get the id of the HTML field that should receive focus
(Inherited from DataNameBase.)
Public propertyIsInGridRecord
Check if this TmplItem is placed (directly) in GridRecord
(Inherited from TmplItem.)
Public propertyIsInsideArray
Check if this TmplItem is contained in an ArrayTable (recursively)
(Inherited from TmplItem.)
Public propertyPublishingName
(Inherited from TmplItem.)
Public propertyRules
Get the RuleCollection from the TmplItem
(Inherited from TmplItem.)
Public propertySubTmplItems
Get the collection of TmplItems contained in this TmplItem
(Inherited from TmplItem.)
Public propertySuperTmplItem
Get/set the parent TmplItem of this TmplItem
(Inherited from TmplItem.)
Public propertyUniqueId
Get the uniqueId for this TmplItem (randomly set in the ctor)
(Inherited from TmplItem.)
Top
See Also