|
 |
| Line 1: |
Line 1: |
| {{CGscriptClass_Template|Name=<nowiki>QuestionInfo</nowiki>|Description=<nowiki>Question metadata from a project questionnaire, with backward-compatible array indexing.</nowiki>|InheritsFrom=Array|Methods={{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
| | [[QuestionTemplate_class]] |
| {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
| |
| |Description=<nowiki>Backward-compatible indexer</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}}
| |
| |Description=<nowiki>Backward-compatible indexer</nowiki>}}|Properties={{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>AnswerOptions</nowiki>|HasGetter=1|Description=<nowiki>The answer options for this question (lazy-loaded)</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Average</nowiki>|HasGetter=1|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>The primary key of this question</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Label</nowiki>|HasGetter=1|Description=<nowiki>The label (short code) of the question</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Max</nowiki>|HasGetter=1|Description=<nowiki>Largest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Min</nowiki>|HasGetter=1|Description=<nowiki>Smallest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>SubQuestions</nowiki>|HasGetter=1|Description=<nowiki>The sub-questions (grid rows) for this question (lazy-loaded)</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Sum</nowiki>|HasGetter=1|Description=<nowiki>Sum of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Text</nowiki>|HasGetter=1|Description=<nowiki>The localized text of the question</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Type</nowiki>|HasGetter=1|Description=<nowiki>The question type (Single, Multi, Grid, etc.)</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}|StaticMethods={{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>QuestionInfo_getAll</nowiki>|Description=<nowiki>Returns all questions in the current Questionnaire context</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>QuestionInfo_getAll</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>Questionnaire resource id</nowiki>|Description=<nowiki>The Questionnaire resource id</nowiki>}}
| |
| |Description=<nowiki>Returns all questions for the given Questionnaire resource id</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=QuestionInfo|Name=<nowiki>QuestionInfo_getQuestion</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=string|Name=<nowiki>Question label</nowiki>|Description=<nowiki>Label of the question</nowiki>}}
| |
| |Description=<nowiki>Returns the question object for the given label</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=QuestionInfo|Name=<nowiki>QuestionInfo_getQuestion</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=string|Name=<nowiki>Question label</nowiki>|Description=<nowiki>Label of the question</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>Iso-code</nowiki>|Description=<nowiki>Language ISO code</nowiki>}}
| |
| |Description=<nowiki>Returns the question object for the given label and language</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=QuestionInfo|Name=<nowiki>QuestionInfo_getQuestionByIndex</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>Question index</nowiki>|Description=<nowiki>Index of the question</nowiki>}}
| |
| |Description=<nowiki>Returns the question at the given index in the current Questionnaire context</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=QuestionInfo|Name=<nowiki>QuestionInfo_getQuestionByIndex</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>Question index</nowiki>|Description=<nowiki>Index of the question</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Questionnaire resource id</nowiki>|Description=<nowiki>The Questionnaire resource id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>Iso-code</nowiki>|Description=<nowiki>Language ISO code</nowiki>}}
| |
| |Description=<nowiki>Returns the question at the given index for the specified Questionnaire and language</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>QuestionInfo_getQuestions</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>The Questionnaire resource id</nowiki>}}
| |
| |Description=<nowiki>Returns question objects for all given labels in a Questionnaire</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>QuestionInfo_getQuestions</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>The Questionnaire resource id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>questionLabels</nowiki>|Description=<nowiki>Array of question labels to return</nowiki>}}
| |
| |Description=<nowiki>Returns question objects for the specified labels in a Questionnaire</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>QuestionInfo_getQuestions</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>The Questionnaire resource id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>questionLabels</nowiki>|Description=<nowiki>Array of question labels to return</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>isoCode</nowiki>|Description=<nowiki>ISO language code to filter results by (empty for user language)</nowiki>}}
| |
| |Description=<nowiki>Returns question objects for the specified labels in a Questionnaire, filtered to a given language</nowiki>}}}}
| |
