QuestionnaireTemplate class - Revision history

Antester@voxmeter.dk at 04:58, 31 March 2026

2026-03-31T04:58:21Z

Administrator at 07:51, 11 May 2022

2022-05-11T07:51:38Z

← Older revision		Revision as of 07:51, 11 May 2022
Line 118:		Line 118:
	<source lang="javascript">		<source lang="javascript">
	//get question group		//get question group
	Questionnaire qnaire = new Questionnaire (~~17148159~~);		Questionnaire qnaire = new Questionnaire (17148177);
	QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);		QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
	qt.Groups;//QuestionGroupRoot		qt.Groups;//QuestionGroupRoot
	</source>		</source>

Administrator at 04:02, 11 May 2022

2022-05-11T04:02:13Z

@@ Line 58: / Line 58: @@
 </source>
 <source lang="javascript">
-//set qnaire property
+//set, get a qnaire property
 Questionnaire qnaire = new Questionnaire (17148177);
 QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
@@ Line 86: / Line 86: @@
 	else print (p.PropertyTypeAsString +": "+ p.Value);
+}
 </source>

Administrator at 03:17, 11 May 2022

2022-05-11T03:17:17Z

← Older revision		Revision as of 03:17, 11 May 2022
Line 46:		Line 46:
	{{CGscriptMethods_Template\|ReturnType=Dictionary\|Name=<nowiki>QuestionnaireTemplate_getActiveLanguages</nowiki>\|Description=<nowiki>Return a Dictionary of all languages supported in system. The dictionary item has key is iso code and value is object {isocode: string, name: string, viewerSupported: bool}</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Dictionary\|Name=<nowiki>QuestionnaireTemplate_getActiveLanguages</nowiki>\|Description=<nowiki>Return a Dictionary of all languages supported in system. The dictionary item has key is iso code and value is object {isocode: string, name: string, viewerSupported: bool}</nowiki>}}
	}}		}}
			=== <span style="color:#DF8621">'''Examples'''</span> ===
			<source lang="javascript">
			// new QuestionnaireTemplate
			string qnaireTemplateName = "test";
			number parentId = 17148135;
			number resourceTemplateId = 17148218;// 0 to use the default
			QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaireTemplateName, parentId, resourceTemplateId);
			bool increaseStructureVersion = false;//Increase structure version will force reset all QAS sequence
			qt.Save(increaseStructureVersion);
			//Catglobe.Json.Encode(qt);
			</source>
			<source lang="javascript">
			//set qnaire property
			Questionnaire qnaire = new Questionnaire (17148177);
			QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
			print(qt.Languages);//{en-GB,da-DK}
			LocalizedString a = new LocalizedString ({"": "Completed", "da-DK": "Komplet"}, "en-GB");
			qt.SetProperty(Question_Property_QuestionnaireCompletedText, a);
			qt.Save(false);
			print(qt.GetProperty(Question_Property_QuestionnaireCompletedText).ToDictionary());//{"": Completed, "da-DK": Komplet}
			</source>
			<source lang="javascript">
			//Remore an existing qnaire property
			Questionnaire qnaire = new Questionnaire (17148177);
			QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
			qt.SetProperty(Question_Property_QuestionnaireCompletedText, empty);
			qt.Save(false);
			print(qt.GetProperty(Question_Property_QuestionnaireCompletedText));//empty
			</source>
			<source lang="javascript">
			//get all existing qnaire properties
			Questionnaire qnaire = new Questionnaire (17148177);
			QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
			print(qt.Properties);//{QuestionnaireProperty,...}
			for(i for 0; qt.Properties.Count){
			QuestionnaireProperty p = qt.Properties[i];
			if(p.IsLocalize)
			print(p.PropertyTypeAsString +": "+ convertToString(p.Value.ToDictionary()));
			else print (p.PropertyTypeAsString +": "+ p.Value);
			}
			</source>

Administrator: Created page with "{{CGscriptClass_Template |Name=QuestionnaireTemplate |Description=The questionnaire template. |InheritsFrom=object|Constructors= {{CGscriptCo..."

2022-04-25T09:33:13Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>QuestionnaireTemplate</nowiki> |Description=<nowiki>The questionnaire template.</nowiki> |InheritsFrom=object|Constructors= {{CGscriptCo..."

New page

{{CGscriptClass_Template
|Name=<nowiki>QuestionnaireTemplate</nowiki>
|Description=<nowiki>The questionnaire template.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of questionnaire template</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire template</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>qualifiedName</nowiki>|Description=<nowiki>Qualified name of questionnaire</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire template by name</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Questionnaire's name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Resource parent's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateId</nowiki>|Description=<nowiki>Resource tempalte's id of questionnaire template. Set it's 0 to use default resource template</nowiki>}}
|Description=<nowiki>Create new questionnaire template</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>GetProperty</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=PropertyType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Use constant Question_Property_xxxx</nowiki>}}
|Description=<nowiki>Get value of property type, return empty if not found</nowiki>}}
{{CGscriptMethods_Template|ReturnType=QuestionTemplate|Name=<nowiki>GetQuestion</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>label</nowiki>|Description=<nowiki>Question label</nowiki>}}
|Description=<nowiki>Return a question by label or empty if not found</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>increaseStructureVersion</nowiki>|Description=<nowiki>Increase structure version will force reset all QAS sequence</nowiki>}}
|Description=<nowiki>Save questionnaire template</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetProperty</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=PropertyType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Use constant Question_Property_xxxx</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>String or LocalizedString depend on property type. If value is empty then the property will be removed</nowiki>}}
|Description=<nowiki>Set value for property type</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DefaultLanguage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Gets and sets the default language of this questionnaire. Its value is language iso code</nowiki>}}
{{CGscriptProperties_Template|ReturnType=QuestionGroupRoot|Name=<nowiki>Groups</nowiki>|HasGetter=1|Description=<nowiki>Information about question groups in questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>HasData</nowiki>|HasGetter=1|Description=<nowiki>check if this questionnaire temaplte contains data or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Reosurce id of questionnaire template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Languages</nowiki>|HasGetter=1|Description=<nowiki>Active languages associated with this questionnaire. Its value is language iso code</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire template name</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ParentId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Parent resource's id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Properties</nowiki>|HasGetter=1|Description=<nowiki>Get configuration properties of this questionnaire template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QualifiedName</nowiki>|HasGetter=1|Description=<nowiki>Get qualified name of questionnaire name</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Questions</nowiki>|HasGetter=1|Description=<nowiki>Get configuration questions of this questionnaire template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Resource tempalte's id of questionnaire template. Set it's 0 to use default resource template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>StructureVersion</nowiki>|HasGetter=1|Description=<nowiki>Structure version of the questionnaire template. It is increased when updating</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Version</nowiki>|HasGetter=1|Description=<nowiki>Version of the questionnaire template. It is increased when updating</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=QuestionnaireTemplate|Name=<nowiki>QuestionnaireTemplate_current</nowiki>|Description=<nowiki>Get questionnaire template in current QAS or PQ context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>QuestionnaireTemplate_getActiveLanguages</nowiki>|Description=<nowiki>Return a Dictionary of all languages supported in system. The dictionary item has key is iso code and value is object {isocode: string, name: string, viewerSupported: bool}</nowiki>}}
}}

← Older revision		Revision as of 04:58, 31 March 2026
Line 1:		Line 1:
	{{CGscriptClass_Template		{{CGscriptClass_Template
	\|Name=<nowiki>QuestionnaireTemplate</nowiki>		\|Name=<nowiki>QuestionnaireTemplate</nowiki>
	\|Description=<nowiki>~~The~~ questionnaire ~~template~~.</nowiki>		\|Description=<nowiki>Template for a questionnaire.</nowiki>
	\|InheritsFrom=object\|Constructors=		\|InheritsFrom=object\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>id</nowiki>\|Description=<nowiki>Id of questionnaire template</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>id</nowiki>\|Description=<nowiki>Id of questionnaire template</nowiki>}}
	\|Description=<nowiki>Fetch exists questionnaire template</nowiki>}}		\|Description=<nowiki>Fetch exists questionnaire template - it is highly recommended to use QuestionnaireTemplate_getCached if just reading</nowiki>}}
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>qualifiedName</nowiki>\|Description=<nowiki>Qualified name of questionnaire</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>qualifiedName</nowiki>\|Description=<nowiki>Qualified name of questionnaire</nowiki>}}
Line 20:		Line 20:
	\|Description=<nowiki>Return a question by label or empty if not found</nowiki>}}		\|Description=<nowiki>Return a question by label or empty if not found</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>increaseStructureVersion</nowiki>\|Description=<nowiki>Increase structure version will force reset all QAS sequence</nowiki>}}		{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>increaseStructureVersion</nowiki>\|Description=<nowiki>Increase structure version will force reset all QAS sequence. Be careful when setting this to false.</nowiki>}}
	\|Description=<nowiki>Save questionnaire template</nowiki>}}		\|Description=<nowiki>Save questionnaire template</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetProperty</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetProperty</nowiki>\|Parameters=
Line 29:		Line 29:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>DefaultLanguage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Gets and sets the default language of this questionnaire. Its value is language iso code</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>DefaultLanguage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Gets and sets the default language of this questionnaire. Its value is language iso code</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=QuestionGroupRoot\|Name=<nowiki>Groups</nowiki>\|HasGetter=1\|Description=<nowiki>Information about question groups in questionnaire</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=QuestionGroupRoot\|Name=<nowiki>Groups</nowiki>\|HasGetter=1\|Description=<nowiki>Information about question groups in questionnaire</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>HasData</nowiki>\|HasGetter=1\|Description=<nowiki>check if this questionnaire ~~temaplte~~ contains data or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>HasData</nowiki>\|HasGetter=1\|Description=<nowiki>check if this questionnaire template contains data or not</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>~~Reosurce~~ id of questionnaire template</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Resource id of questionnaire template</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=array\|Name=<nowiki>Languages</nowiki>\|HasGetter=1\|Description=<nowiki>Active languages associated with this questionnaire. Its value is language iso code</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=array\|Name=<nowiki>Languages</nowiki>\|HasGetter=1\|Description=<nowiki>Active languages associated with this questionnaire. Its value is language iso code</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Questionnaire template name</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Questionnaire template name</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ParentId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Parent resource's id</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ParentId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Parent resource's id</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~array~~\|Name=<nowiki>Properties</nowiki>\|HasGetter=1\|Description=<nowiki>Get configuration properties of this questionnaire template</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=Array of QuestionnaireProperty\|Name=<nowiki>Properties</nowiki>\|HasGetter=1\|Description=<nowiki>Get configuration properties of this questionnaire template</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>QualifiedName</nowiki>\|HasGetter=1\|Description=<nowiki>Get qualified name of questionnaire name</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>QualifiedName</nowiki>\|HasGetter=1\|Description=<nowiki>Get qualified name of questionnaire name</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~array~~\|Name=<nowiki>Questions</nowiki>\|HasGetter=1\|Description=<nowiki>Get configuration questions of this questionnaire template</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=Array of QuestionTemplate\|Name=<nowiki>Questions</nowiki>\|HasGetter=1\|Description=<nowiki>Get configuration questions of this questionnaire template</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ResourceTemplateId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Resource tempalte's id of questionnaire template. Set it's 0 to use default resource template</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ResourceTemplateId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Resource tempalte's id of questionnaire template. Set it's 0 to use default resource template</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>StructureVersion</nowiki>\|HasGetter=1\|Description=<nowiki>Structure version of the questionnaire template. It is increased when updating</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>StructureVersion</nowiki>\|HasGetter=1\|Description=<nowiki>Structure version of the questionnaire template. It is increased when updating</nowiki>}}
Line 45:		Line 45:
	{{CGscriptMethods_Template\|ReturnType=QuestionnaireTemplate\|Name=<nowiki>QuestionnaireTemplate_current</nowiki>\|Description=<nowiki>Get questionnaire template in current QAS or PQ context</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=QuestionnaireTemplate\|Name=<nowiki>QuestionnaireTemplate_current</nowiki>\|Description=<nowiki>Get questionnaire template in current QAS or PQ context</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Dictionary\|Name=<nowiki>QuestionnaireTemplate_getActiveLanguages</nowiki>\|Description=<nowiki>Return a Dictionary of all languages supported in system. The dictionary item has key is iso code and value is object {isocode: string, name: string, viewerSupported: bool}</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Dictionary\|Name=<nowiki>QuestionnaireTemplate_getActiveLanguages</nowiki>\|Description=<nowiki>Return a Dictionary of all languages supported in system. The dictionary item has key is iso code and value is object {isocode: string, name: string, viewerSupported: bool}</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=QuestionnaireTemplate\|Name=<nowiki>QuestionnaireTemplate_getCached</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>id</nowiki>\|Description=<nowiki>Id of questionnaire template</nowiki>}}
			\|Description=<nowiki>Fetch exists questionnaire template using a cached version. Do not use when editing</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=QuestionnaireTemplate\|Name=<nowiki>QuestionnaireTemplate_getCachedFromQuestionnaireId</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>id</nowiki>\|Description=<nowiki>Id of questionnaire template</nowiki>}}
			\|Description=<nowiki>Fetch exists questionnaire template using a cached version using the questionnaire id. Do not use when editing</nowiki>}}
	}}		}}
	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===