Difference between revisions of "ScaleQuestion class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>ScaleQuestion</nowiki> |Description=<nowiki>Question container for Scale questions</nowiki> |Methods= {{CGscriptMethods_Template|ReturnT...") |
|||
(4 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
|Name=<nowiki>ScaleQuestion</nowiki> | |Name=<nowiki>ScaleQuestion</nowiki> | ||
|Description=<nowiki>Question container for Scale questions</nowiki> | |Description=<nowiki>Question container for Scale questions</nowiki> | ||
− | |Methods= | + | |InheritsFrom=Question|Methods= |
− | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the 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>|Inherited=Question|Parameters= | ||
+ | {{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>}} | ||
+ | {{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|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=string|Name=<nowiki>QuestionLabel</nowiki>|HasGetter=1|Inherited=Question|Description=<nowiki>Label of the question</nowiki>}} |
+ | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} | ||
|StaticMethods= | |StaticMethods= | ||
− | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ScaleQuestion_getLabelsOfLoadedQuestions</nowiki>|Description=<nowiki>Get labels of the questions that have been loaded in current session and might be | + | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ScaleQuestion_getLabelsOfLoadedQuestions</nowiki>|Description=<nowiki>Get labels of the questions that have been loaded in current session and might be saved upon completion</nowiki>}} |
− | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki> | + | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ScaleQuestion_loadQuestions</nowiki>|Description=<nowiki>Load questions</nowiki>}} |
− | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki> | + | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ScaleQuestion_loadQuestions</nowiki>|Parameters= |
{{CGscriptParameters_Template|Type=array|Name=<nowiki>questionLabels</nowiki>|Description=<nowiki>Labels of the questions to load</nowiki>}} | {{CGscriptParameters_Template|Type=array|Name=<nowiki>questionLabels</nowiki>|Description=<nowiki>Labels of the questions to load</nowiki>}} | ||
|Description=<nowiki>Load questions</nowiki>}} | |Description=<nowiki>Load questions</nowiki>}} | ||
− | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki> | + | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ScaleQuestion_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>}} | {{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>}} | |Description=<nowiki>Load questions</nowiki>}} | ||
− | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki> | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ScaleQuestion_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>}} | {{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>}} | |Description=<nowiki>Save questions</nowiki>}} | ||
+ | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ScaleQuestion_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>}} | ||
}} | }} |
Revision as of 08:28, 2 July 2020
ScaleQuestion
Question container for Scale 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) string QuestionLabel { get; } - Label of the question
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Static Methods
- array ScaleQuestion_getLabelsOfLoadedQuestions() - Get labels of the questions that have been loaded in current session and might be saved upon completion
- Dictionary ScaleQuestion_loadQuestions() - Load questions
- Dictionary ScaleQuestion_loadQuestions(array questionLabels "Labels of the questions to load") - Load questions
- Dictionary ScaleQuestion_loadQuestions(array questionLabels "Labels of the questions to load", QAS qas "Qas to load data from") - Load questions
- Empty ScaleQuestion_saveQuestions(Dictionary questionData "Dictionary of labels and data", QAS qas "Qas to save data to") - Save questions
- Empty ScaleQuestion_unloadAll() - 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.