FormContext Class

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

TOPICA-aware context for computations

Inheritance Hierarchy

SystemObject
ComputationContext
CSC.SC.TOPICA4.TemplateFormContext

Namespace: CSC.SC.TOPICA4.Template
Assembly: CSC.SC.TOPICA4.Template (in CSC.SC.TOPICA4.Template.dll) Version: 4.37.7779.15939

Syntax

Copy

public class FormContext : ComputationContext

The FormContext type exposes the following members.

Constructors

	Name	Description
	FormContext(FormContext)	Copy constructor
	FormContext(FormContext, DataDictionaryTable)	Copy constructor, modify table
	FormContext(FormContext, Employee)	Copy constructor, modify Employee
	FormContext(FormContext, OrgUnit)	Copy constructor, modify OrgUnit
	FormContext(FormContext, Patient)	Copy constructor, modify patient
	FormContext(FormContext, Record)	Copy constructor, modify record
	FormContext(FormContext, FormContextFormRenderMode)	Copy constructor, modify FormRenderMode
	FormContext(FormContext, Record, DataDictionaryTable)	Copy constructor, modify parentRecord and table
	FormContext(FormContext, Record, Record)	Copy constructor, modify parentRecord and record
	FormContext(CultureInfo, Database, Dictionary, DataDictionary, ObjectContext)	Constructor using ObjectContext - for backward compatibility
	FormContext(CultureInfo, Database, Dictionary, DataDictionary, ObjectContext, Boolean, String)	Constructor using ObjectContext
	FormContext(CultureInfo, Database, Dictionary, DataDictionary, Page, IFormatter, Boolean, ObjectContext, TmplItem)	Constructor using ObjectContext etc.
	FormContext(CultureInfo, Database, Dictionary, DataDictionary, Page, IFormatter, Boolean, ObjectContext, TmplItem, String)	Constructor using ObjectContext etc.

Top

Properties

	Name	Description
	ArrayTableRow	Get/set ArrayTableRow
	CaptionSuffixChildElements	Get/set CaptionSuffixChildElements. if not null or empty, display this text as a suffix to caption for checkboxes having (hidden) child elements.
	CommonParameters	Get CommonParameters
	ConfigurationMode	In this mode, generate (intially hidden) HTML to facilitate configuration (inspecting / editing form)
	ConfigurationName	Get ConfigurationName
	Copying	Are we performing a copy of an existing form/record
	CultureInfo	(Inherited from ComputationContext.)
	CurrentUser	Obsolete. Get current user
	Database	(Inherited from ComputationContext.)
	DataDictionary	Get DataDictionary
	DataDictionaryTable	Get/set DataDictionaryTable
	DataOwners	Get/set possible data owners
	DateTimeConverter	Get DateTimeConverter
	DebugMode	Get DebugMode
	DebugOutputEvaluateString	(Inherited from ComputationContext.)
	DefaultCaptionValue	Get/set DefaultCaptionValue. If not null or empty, when Caption in form (template) file has this value, use DataName
	Dictionary	Obsolete. (Inherited from ComputationContext.)
	Employee	Returns employee
	EmployeeUser	Get Employee user
	Experimenting	Get Experimenting status (used to test new/alternative code)
	FocusedElementId	If null or emtpy, set foucs on first field with error/warning If not null or empty, set focus on the coresponding field (irrespective of errors/warnings)
	Form	Get/set Form
	FormItem	Get/set FormItem
	GenerateComments	Get/set GenerateComments. When true, comments are generated inline in HTML
	HtmlVersionNumber	Get/Set HtmlVersionNumber
	IComputationMetaData	Obsolete. (Inherited from ComputationContext.)
	IFormatter	Get IFormatter
	IncludeFileInfoCurrent	Get the current node of the tree of included files
	IncludeFileInfoRoot	Get the root of the tree of included files
	Indicator	Get SelfEvaluationRound
	OrgUnit	The data owner of the form
	OrgUnitTypeCollection	Get OrgUnitTypeCollection
	Page	Get Page
	ParentRecord	Get parent record
	Patient	Get current patient
	PatientUser	Get Patient user
	PhysicalTempFolderUploaded	Returns PhysicalTempFolderUploaded
	PreProcessValues	Return XmlDocument with pre processed values (returned from pre processing aspx)
	Printing	Get whether the form is to be rendered for printing
	Record	Get current record
	RenderConfigurationTools	Get RenderConfigurationTools
	RenderingVersion	Get/set RenderingVersion
	SelfEvaluationRound	Get SelfEvaluationRound
	Skin	Get Skin
	Standard	Get Standard
	StandardVersion	Get StandardVersion
	Strict	(Inherited from ComputationContext.)
	Values	Obsolete. (Inherited from ComputationContext.)

Top

Methods

	Name	Description
	AddIncludeFile	Add a node to the tree of included files, set new current
	AddPreProcessedValues	Add XML output from whatever pre processes have been run
	Bool	Obsolete. (Inherited from ComputationContext.)
	CheckGlobalFunction	Check if name is a global name (constant, enumeration value, function) (Overrides ComputationContext.CheckGlobalFunction(String).)
	ClearVariables	(Inherited from ComputationContext.)
	ContainsKey	(Inherited from ComputationContext.)
	CurrentUserHasPermission	Checks if current user has permissionType
	DebugPrint	(Inherited from ComputationContext.)
	Define	(Inherited from ComputationContext.)
	DefineExpression	(Inherited from ComputationContext.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	EvaluateGlobalFunction	Evaluate global function (Overrides ComputationContext.EvaluateGlobalFunction(Expression).)
	EvaluateString	(Inherited from ComputationContext.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetBool(String)	(Inherited from ComputationContext.)
	GetBool(String, Boolean)	(Inherited from ComputationContext.)
	GetDataOwner	Returns DataOwner
	GetDataSet	(Inherited from ComputationContext.)
	GetDateTime(String)	(Inherited from ComputationContext.)
	GetDateTime(String, DateTime)	(Inherited from ComputationContext.)
	GetEvaluatableObject	Get evaluatable object by name (Overrides ComputationContext.GetEvaluatableObject(String).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInt(String)	(Inherited from ComputationContext.)
	GetInt(String, Int32)	(Inherited from ComputationContext.)
	GetInt2	Obsolete. (Inherited from ComputationContext.)
	GetLocalizedText(String)	Get localizwed text - key value is also default
	GetLocalizedText(String, String)	Get localized text - with specifed default value
	GetSettingsdictinary	Get Settings dictionary
	GetStateMachine	(Inherited from ComputationContext.)
	GetString(String)	(Inherited from ComputationContext.)
	GetString(String, String)	(Inherited from ComputationContext.)
	GetText	Get text from configuration or resource. Priority: 1 configuration 2 resource 3 default value
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	(Inherited from ComputationContext.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReplaceComputation(String)	(Inherited from ComputationContext.)
	ReplaceComputation(String, Boolean)	(Inherited from ComputationContext.)
	ReplaceComputation(String, Char, Char)	(Inherited from ComputationContext.)
	ReplaceComputation(String, Char, Char, Boolean)	(Inherited from ComputationContext.)
	ResetCurrentIncludeFile	Reset current node
	ResolveUrl	Resolve relative URL - examples: Configuration/config/MyForm.aspx ~/Configuration/config/MyForm.aspx #/MyForm.aspx
	SetPreProcessedValues
	SetSettingsdictionary	Set settings dictionary
	SetStateMachine	(Inherited from ComputationContext.)
	StartIncludeFile	Start tree of included files
	Text	Get text (localized) - declared "new" to hide the inherited (should have been virtual...)
	ToString	Convert to string (Overrides ComputationContext.ToString.)

Top

Reference

CSC.SC.TOPICA4.Template Namespace