Difference between revisions of "PageQuestion class"

From Catglobe Wiki
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Result:
 
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
 
|Name=<nowiki>PageQuestion</nowiki>
 
|Name=<nowiki>PageQuestion</nowiki>
 
|Description=<nowiki>Question container for Page questions</nowiki>
 
|Description=<nowiki>Question container for Page questions</nowiki>
|Methods=
+
|InheritsFrom=Question|Methods=
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>AsValue</nowiki>|Description=<nowiki>Convert the Question to plain object</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>AsValue</nowiki>|Inherited=Question|Description=<nowiki>Convert the Question to plain object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Set</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Set</nowiki>|Inherited=Question|Parameters=
 
{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>New value for question</nowiki>}}
 
{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>New value for question</nowiki>}}
 
|Description=<nowiki>Update the question with the given value</nowiki>}}
 
|Description=<nowiki>Update the question with the given value</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=Question|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsChanged</nowiki>|HasGetter=1|Description=<nowiki>True if the value of the question has changed</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsChanged</nowiki>|HasGetter=1|Inherited=Question|Description=<nowiki>True if the value of the question has changed</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=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QasId</nowiki>|HasGetter=1|Inherited=Question|Description=<nowiki>Id of the qas. 0 if no stored data.</nowiki>}}
|StaticMethods=
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QuestionLabel</nowiki>|HasGetter=1|Inherited=Question|Description=<nowiki>Label of the question</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>PageQuestion_getLabelsOfLoadedQuestions</nowiki>|Description=<nowiki>Get labels of the questions that have been loaded in current session and might be saved upon completion</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>PageQuestion_loadQuestions</nowiki>|Description=<nowiki>Load questions</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>UserId</nowiki>|HasGetter=1|Inherited=Question|Description=<nowiki>Id of the user. 0 if no user or no stored data.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>PageQuestion_loadQuestions</nowiki>|Parameters=
 
{{CGscriptParameters_Template|Type=array|Name=<nowiki>questionLabels</nowiki>|Description=<nowiki>Labels of the questions to load</nowiki>}}
 
|Description=<nowiki>Load questions</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>PageQuestion_loadQuestions</nowiki>|Parameters=
 
{{CGscriptParameters_Template|Type=array|Name=<nowiki>questionLabels</nowiki>|Description=<nowiki>Labels of the questions to load</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=QAS|Name=<nowiki>qas</nowiki>|Description=<nowiki>Qas to load data from</nowiki>}}
 
|Description=<nowiki>Load questions</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>PageQuestion_saveQuestions</nowiki>|Parameters=
 
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>questionData</nowiki>|Description=<nowiki>Dictionary of labels and data</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=QAS|Name=<nowiki>qas</nowiki>|Description=<nowiki>Qas to save data to</nowiki>}}
 
|Description=<nowiki>Save questions</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>PageQuestion_unloadAll</nowiki>|Description=<nowiki>Save and remove all loaded questions. Useful if a called script is expected to change current values. Only deletes those referenced directly through question variables.</nowiki>}}
 
 
}}
 
}}

Latest revision as of 04:48, 15 May 2024

PageQuestion


Question container for Page questions

Parent class

Inherits from Question

Methods

  • (From Question) object AsValue() - Convert the Question to plain object
  • (From Question) Empty Set(object value "New value for question") - Update the question with the given value
  • (From Question) string ToString() - The string representation of the object.

Properties

  • (From Question) bool IsChanged { get; } - True if the value of the question has changed
  • string ObjectTypeName { get; } - The name of the type of object.
  • (From Question) int QasId { get; } - Id of the qas. 0 if no stored data.
  • (From Question) string QuestionLabel { get; } - Label of the question
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.
  • (From Question) int UserId { get; } - Id of the user. 0 if no user or no stored data.