StructureElement Class |
[This is preliminary documentation and is subject to change.]
Namespace: CSC.SC.TOPICA4.Template
public class StructureElement : StructureBase
The StructureElement type exposes the following members.
Name | Description | |
---|---|---|
![]() | StructureElement |
Default constructor
|
![]() | StructureElement(CaptionBase) |
Default constructor
|
![]() | StructureElement(DataNameBase) |
Default constructor
|
![]() | StructureElement(TmplItem) |
Default constructor
|
Name | Description | |
---|---|---|
![]() | Add |
Add sub-item
(Inherited from TmplItem.) |
![]() | AddComputation |
Add computation
(Inherited from TmplItem.) |
![]() | 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.
(Inherited from TmplItem.) |
![]() | 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.
(Inherited from TmplItem.) |
![]() | AddRule |
Add specified rule to rulcollection
(Inherited from TmplItem.) |
![]() | AllowChild(Type) |
Allow as child StructureElement or StructureReference
(Overrides TmplItemAllowChild(Type).) |
![]() | AllowChild(TmplItem) |
Allow as child only other StructureElements
(Overrides TmplItemAllowChild(TmplItem).) |
![]() | AttributeString |
Returns Attributestring
(Overrides StructureBaseAttributeString.) |
![]() | CheckAll(ProgressCollection, String, String) |
Check TmplItem - including sub-items - for inconsistencies
(Inherited from TmplItem.) |
![]() | CheckAll(ProgressCollection, String, String, Boolean) |
Check TmplItem - including sub-items - for inconsistencies
(Inherited from TmplItem.) |
![]() | CheckReport(ProgressCollection, String, String) |
Check TmplItem
(Inherited from TmplItem.) |
![]() | CheckReport(Boolean, ProgressCollection, String, String) |
Check TmplItem - optionally write header and footer
(Inherited from TmplItem.) |
![]() | CheckRules(FormContext, CheckRulesResult) |
Check rules (including fill-in-status) on this item and all subitems
(Inherited from TmplItem.) |
![]() | CheckRules(FormContext, MessageCollection, CheckRulesResult) |
Check rules (including fill-in-status) on this item and all subitems
(Inherited from TmplItem.) |
![]() | CheckRules1 |
Check rules (including fill-in-status) on this element only
(Inherited from TmplItem.) |
![]() | ClearMessages |
Remove all messages
(Inherited from TmplItem.) |
![]() | ClearMessages(MessageSource) |
Remove all messages from a specific source
(Inherited from TmplItem.) |
![]() | Clone |
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.) |
![]() | ComputeVisibility | (Inherited from TmplItem.) |
![]() | 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
(Inherited from TmplItem.) |
![]() | DataClear |
Clear data from the TmplItem
(Inherited from TmplItem.) |
![]() | DataDictionary |
DataDictionary processing for this TmplItem and all sub-items.
Maintains list of parent tables.
(Inherited from TmplItem.) |
![]() | DataDictionaryFieldAdd |
Utility method to add field to DataDictionary
(Inherited from TmplItem.) |
![]() | DataDictionaryFieldCreate(DataDictionary, DataType, Int32, ProgressCollection, String, Boolean) |
Utility method to create a DataDictionary field - not inserted in DataDictionary!
(Inherited from TmplItem.) |
![]() | DataDictionaryFieldCreate(DataDictionary, DataType, String, Int32, ProgressCollection, String, Boolean) |
Utility method to create a DataDictionary field - not inserted in DataDictionary!
(Inherited from TmplItem.) |
![]() | DataDictionaryTableCreate |
Utility method to create table in DataDictionary
(Inherited from TmplItem.) |
![]() | DataDictionaryTableFieldAdd |
Utility method to add a field to the current table
(Inherited from TmplItem.) |
![]() | DataGet |
Get data from submitted HTML form into TemplItem
(Inherited from TmplItem.) |
![]() | DataLoad |
Load data from DynamicRecord dynRec into TmplItem
(Inherited from TmplItem.) |
![]() | DataPostSave |
Called after the record is saved to facilitate various clean-up
(Inherited from TmplItem.) |
![]() | DataSave |
Save data from TmplItem into DynamicRecord dynRec (Inherited from TmplItem.) |
![]() | DebugPrint |
Print to debug listener
(Inherited from TmplItem.) |
![]() | DebugPrint(String) |
Print to debug listener
(Inherited from TmplItem.) |
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Evaluate |
Evaluate
(Inherited from TmplItem.) |
![]() | EvaluateSpecific |
Enables sub classes to implement specific evaluation functionality
(Inherited from TmplItem.) |
![]() | 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
(Inherited from TmplItem.) |
![]() | FindByHTMLName |
Returns tmpItem that matches specified htmlname
(Inherited from TmplItem.) |
![]() | FindById |
Search the tree from this node to find a TmplItem with the given id (optionally search recusively)
(Inherited from TmplItem.) |
![]() | FindByUniqueId |
Search the tree from this node to find a TmplItem with the given UniqueId (optionally search recusively)
(Inherited from TmplItem.) |
![]() | FormInit | (Inherited from TmplItem.) |
![]() | GetActualHistoryCaption |
Returns a Caption for displaying in the history tree
(Inherited from DataNameBase.) |
![]() | GetArrayTableContainer |
Returns the ArrayTable that this TmplItem is contained in (null is the
TmplItem isn't contained in an array)
(Inherited from TmplItem.) |
![]() | GetCaption |
Gets Caption
(Inherited from CaptionBase.) |
![]() | GetDataName |
Returns dataname
(Inherited from DataNameBase.) |
![]() | GetDefaultChild |
Returns the default type (subclass of TmplItem) of child this object prefers
(Inherited from TmplItem.) |
![]() | GetFillInStatus |
Get the fill in status of this template item
(Inherited from DataNameBase.) |
![]() | GetGlobalStringResource(String) |
Gets the global string resource. Default to using 'TOPICA' as ClassKey.
(Inherited from TmplItem.) |
![]() | GetGlobalStringResource(String, String) |
Gets the global string resource.
(Inherited from TmplItem.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetHistoryCaption |
Gets Caption
(Inherited from CaptionBase.) |
![]() | GetLocalStringResource(String, String) |
Gets the local string resource.
(Inherited from TmplItem.) |
![]() | GetLocalStringResource(String, String, CultureInfo) |
Gets the local string resource.
(Inherited from TmplItem.) |
![]() | GetMessages |
Get all messages (recursively for entire TmplItem tree)
(Inherited from TmplItem.) |
![]() | GetPostProcess |
Get collection of currently selected post-processing commands
(Inherited from TmplItem.) |
![]() | GetPreProcess |
Collect pre-processing commands recursively (for alle visible elements)
(Inherited from TmplItem.) |
![]() | GetPreProcessedValue |
Get value of attribute addressed by Xpath expression in PreProcessInstruction
(Inherited from DataNameBase.) |
![]() | GetSubItemsByType |
Get all subitems with a specified type
(Inherited from TmplItem.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | HTMLFormName |
Returns the HTML name of the form tag
(Inherited from TmplItem.) |
![]() | HTMLWrite |
Write HTML: whole TmplItem (caption and control inside span tag)
(Inherited from TmplItem.) |
![]() | IncludeCount |
Get # of Include-items (used to decide whether include-resolving is necessary)
(Inherited from TmplItem.) |
![]() | InsertAfter |
Insert ti after this TmplItem
(Inherited from TmplItem.) |
![]() | InsertBefore |
Insert ti before this TmplItem
(Inherited from TmplItem.) |
![]() | JavaScriptFocus | (Inherited from TmplItem.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MergeInclude |
Merge merge in place of first include item
(Inherited from TmplItem.) |
![]() | NumberString |
Set number strings
(Inherited from TmplItem.) |
![]() | 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
(Inherited from TmplItem.) |
![]() | OnPreRenderComplete |
Do some postprocesseing immediately after the whole page has been generated.
(Inherited from TmplItem.) |
![]() | Renumber |
Renumber id 1, 2, 3, ... in whole hierarchy (depth first)
(Inherited from TmplItem.) |
![]() | Renumber(Int32) |
Renumber id in hierarchy (depth first)
(Inherited from TmplItem.) |
![]() | SetComputation(String, String) |
Set commputation with name and expression expr (Inherited from TmplItem.) |
![]() | SetComputation(DataDictionaryComputationName, String) |
Set commputation with name and expression expr (Inherited from TmplItem.) |
![]() | SetCustomPropertiesOnDataDictionaryTable |
Set custom properties to specified datadictonary table
(Overrides TmplItemSetCustomPropertiesOnDataDictionaryTable(DataDictionaryTable).) |
![]() | SetDefault |
Set default value
(Inherited from TmplItem.) |
![]() | SetFromPreProcessed |
Override this method to set data of the template item from the pre processed data
(Inherited from TmplItem.) |
![]() | Top |
Get the top item.
(Inherited from TmplItem.) |
![]() | ToString |
For debugging
(Inherited from TmplItem.) |
![]() | WriteStructure |
Write hierarchical structure of this TmplItem and sub-items
(Inherited from TmplItem.) |
![]() | XMLLoad |
Load attributes and subelements from node, optionally resolving includes
(Inherited from TmplItem.) |
![]() | XMLWrite(XmlTextWriter) |
Write TmplItem - (including sub-items) to XML file
(Inherited from TmplItem.) |
![]() | XMLWrite(String, Encoding) |
Write TmplItem - including sub-items - to XML file
(Inherited from TmplItem.) |
![]() | XMLWrite(XmlTextWriter, Boolean) |
Write TmplItem - (including sub-items) to XML file
(Inherited from TmplItem.) |
![]() | XMLWrite(Stream, Encoding, Boolean) |
Write TmplItem - including sub-items - to (Inherited from TmplItem.) |
![]() | XMLWrite(String, Encoding, Boolean) |
Write TmplItem - including sub-items - to XML file
(Inherited from TmplItem.) |
![]() | XMLWrite(Stream, Encoding, Boolean, Boolean) |
Write TmplItem - including sub-items - to (Inherited from TmplItem.) |
Name | Description | |
---|---|---|
![]() | AccessModeDenied |
Handling of denied read access
(Inherited from StructureBase.) |
![]() | AccessModeRead |
Access control mode for read
(Inherited from StructureBase.) |
![]() | AccessModeWrite |
Access control mode for write
(Inherited from StructureBase.) |
![]() | AllowCascadeDelete |
Expression to allow "cascade delete" - default: true
|
![]() | AllowCopy |
Expression to allow copy - default: false
|
![]() | AllowCreate |
Expression to allow create - default: true
|
![]() | AllowDelete |
Expression to allow delete - default: true
|
![]() | AllowMerge |
Expression to allow merge - default: false
|
![]() | AllowMove |
Expression to allow move - default: false
|
![]() | AllowRead |
Expression to allow read - default: true
|
![]() | AllowUpdate |
Expression to allow update - default: true
|
![]() | Approve |
Force approval
|
![]() | AugmentedView |
Generate "augmented" view
|
![]() | AutoCreate |
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)
|
![]() | Caption |
Field label etc. displayed in data entry form
(Inherited from CaptionBase.) |
![]() | Cardinality |
Cardinality (1:1 or 1:N)
|
![]() | ClassNameControl |
Stylesheet classname for control
(Inherited from TmplItem.) |
![]() | ClassNameControlCell |
Stylesheet classname for table cell containing control
(Inherited from TmplItem.) |
![]() | ClassNameLabel |
Stylesheet classname for label
(Inherited from TmplItem.) |
![]() | ClassNameLabelCell |
Stylesheet classname for table cell containing label
(Inherited from TmplItem.) |
![]() | ClearOnCopy |
This TmplItem will be cleared when copying
(Inherited from TmplItem.) |
![]() | Closable |
Enable closing.
|
![]() | Comment |
Internal comment for use by designer
(Inherited from TmplItem.) |
![]() | Computation |
Expression that computes default value for field
(Inherited from DataNameBase.) |
![]() | ConvertInfo |
Misc. conversion info.
(Inherited from TmplItem.) |
![]() | CreateOrgUnitList |
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.
|
![]() | DataName |
Name of table / field in data base
(Inherited from DataNameBase.) |
![]() | DefaultLastPrevious |
True => field default value is set to last previous value
(Inherited from DataNameBase.) |
![]() | DefaultLastPreviousPrompt |
Prompt for copying default data from previous record.
|
![]() | DefaultLastPreviousSource |
Source of "last previous" default data,
e.g. specifies from shre to copy values.
|
![]() | Deleted |
TmplItem (and anything below it) is skipped when generating DataDictionary,
so fields will not be generated in database.
(Inherited from TmplItem.) |
![]() | Description |
Textual description of field definition, use, etc.
(Inherited from DataNameBase.) |
![]() | DisplayAtTop |
Objects are always displayed in the top of the hierarchy (i.e. not sorted)
|
![]() | DisplayDate |
Expression to compute display date
|
![]() | DisplayName |
Expression to compute display name
|
![]() | ExcludeFromPrint |
The TmplItem is excluded from the printed version of the form
(Inherited from TmplItem.) |
![]() | FillInStatusComputation |
Specifies how empty field is treated
(Inherited from DataNameBase.) |
![]() | FillInStatusSelect |
Specifies how empty field is treated
(Inherited from DataNameBase.) |
![]() | FlatView |
Generate "flat" view
|
![]() | FormFilename |
Name of referenced file
|
![]() | Hidden |
Hidden fields generate fields in DataDictionary (and hence database),
but are not visible in input form.
(Inherited from TmplItem.) |
![]() | HistoryCaption |
Field label displayed in history tree (
(Inherited from CaptionBase.) |
![]() | HTMLName |
Field name in generated HTML form (blank: use DataName)
(Inherited from CaptionBase.) |
![]() | ImageFile |
Image file
(Inherited from StructureBase.) |
![]() | Link |
Reference (e.g. URL) to field definition
(Inherited from DataNameBase.) |
![]() | ListColumn |
Columns in automatically generated list views are sorted by this value.
(Inherited from DataNameBase.) |
![]() | MapToExternalField |
Corresponding field name in som external system - used for mapping during import/export
(Inherited from DataNameBase.) |
![]() | MergeByFieldName |
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).
|
![]() | MergeNewestFieldName |
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!
|
![]() | MergePatientLevel |
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.
|
![]() | Number |
Should this field be numbered
(Inherited from CaptionBase.) |
![]() | OnBlur |
Custom script for onblur-event
(Inherited from TmplItem.) |
![]() | OnChange |
Custom script for onchange-event
(Inherited from TmplItem.) |
![]() | OnClick |
Custom script for onclick-event
(Inherited from TmplItem.) |
![]() | OnFocus |
Custom script for onfocus-event
(Inherited from TmplItem.) |
![]() | OnKeyDown |
Custom script for onkeydown-event
(Inherited from TmplItem.) |
![]() | OnKeyPress |
Custom script for onkeypress-event
(Inherited from TmplItem.) |
![]() | OnKeyUp |
Custom script for onkeyup-event
(Inherited from TmplItem.) |
![]() | OrgUnitConfigure |
true iff this type of objects may be configured for individual org.units
|
![]() | OrgUnitRelation |
Type of relation between records and org.unit (data owner)
|
![]() | PatientAccessMode |
What access is allowed on this structure when logged in as patient
(Inherited from StructureBase.) |
![]() | Plan |
Allow planning
|
![]() | PostProcess |
Code (e.g. .aspx) to execute on save
(Inherited from TmplItem.) |
![]() | PreProcess |
Code (e.g. .aspx) to execute on load
(Inherited from TmplItem.) |
![]() | PreProcessInstruction |
XPath expression to find values in preprocessed xml (MUST address an attribute)
(Inherited from DataNameBase.) |
![]() | PublishChanges |
If true, the control is registered as a publisher, which means other controls can subscribe to changes on this control
(Inherited from DataNameBase.) |
![]() | ReadFromFile |
The disk file this TmplItem was read from
(Inherited from TmplItem.) |
![]() | ReadOnly |
Read only expression - if expression evaluates true, field may not be edited
(Inherited from DataNameBase.) |
![]() | RunPreProcessInstructionOnEdit |
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.) |
![]() | Search |
Enable search by record ID etc.
|
![]() | SetValueOnCopy |
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.) |
![]() | SingleOpenMode |
Only 1 open record.
Only relevant when Closable == true.
|
![]() | SortByField |
Field to sort by
(Inherited from StructureBase.) |
![]() | SortDescending |
Sort direction
(Inherited from StructureBase.) |
![]() | StructureType |
Type that must be defined by configurator (classification of tables)
|
![]() | StyleControl |
Inline style for control
(Inherited from TmplItem.) |
![]() | StyleControlCell |
Inline style for table cell containing control
(Inherited from TmplItem.) |
![]() | StyleLabel |
Inline style for label
(Inherited from TmplItem.) |
![]() | StyleLabelCell |
Inline style for table cell containng label
(Inherited from TmplItem.) |
![]() | subTmplItems |
tmpItemcollection
(Inherited from TmplItem.) |
![]() | Tooltip |
Tooltip
(Inherited from CaptionBase.) |
![]() | TooltipComputation |
Expression to compute tooltip value
(Inherited from CaptionBase.) |
![]() | URLHelp |
URL with help etc. for this field
(Inherited from CaptionBase.) |
![]() | ViewName |
Name of table / field in autogenerated views (optional - defaults to DataName)
(Inherited from DataNameBase.) |
![]() | VisibleComputation |
Computation (formula) controlling visibility of item - true => item is visible
(Inherited from TmplItem.) |
Name | Description | |
---|---|---|
![]() | Computations |
Get the DataDictionaryComputationCollection from the TmplItem
(Inherited from TmplItem.) |
![]() | CustomQueries |
Get collection of custom queries
|
![]() | FocusId |
Return id for the HTML element to focus
(Inherited from TmplItem.) |
![]() | FocusSelect |
Return whether a focused element may be selected (e.g. whether .select() should be called)
(Inherited from TmplItem.) |
![]() | Id |
get/set ID
(Inherited from TmplItem.) |
![]() | IdOfFieldToReceiveFocus |
Get the id of the HTML field that should receive focus
(Inherited from DataNameBase.) |
![]() | IsInGridRecord |
Check if this TmplItem is placed (directly) in GridRecord
(Inherited from TmplItem.) |
![]() | IsInsideArray |
Check if this TmplItem is contained in an ArrayTable (recursively)
(Inherited from TmplItem.) |
![]() | PublishingName | (Inherited from TmplItem.) |
![]() | Rules |
Get the RuleCollection from the TmplItem
(Inherited from TmplItem.) |
![]() | SubTmplItems |
Get the collection of TmplItems contained in this TmplItem
(Inherited from TmplItem.) |
![]() | SuperTmplItem |
Get/set the parent TmplItem of this TmplItem
(Inherited from TmplItem.) |
![]() | UniqueId |
Get the uniqueId for this TmplItem (randomly set in the ctor)
(Inherited from TmplItem.) |