Click or drag to resize
StructureElement Fields

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

The StructureElement type exposes the following members.

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
See Also