Revision as of 09:47, 25 April 2022

QuestionGroupBranch

Question group.

Parent class

Inherits from QuestionGroupTree

Constructors

(string name "Group name", QuestionnaireTemplate qt "Questionnaire template") - Create a brand group

Methods

Array of QuestionGroupTree GetChildGroups() - Return all child groups.
Empty SetChildGroups(Array of QuestionGroupTree groups "Question groups") - Set child groups.
(From object) string ToString() - The string representation of the object.

Properties

(From QuestionGroupTree) Array of string AllQuestions { get; } - Labels of all questions in this group
int Count { get; } - How many children in this group
(From QuestionGroupTree) string GroupName { get; set; } - Name of question group
(From QuestionGroupTree) bool IsLeaf { get; } - Check if it is leaf group or not
string ObjectTypeName { get; } - The name of the type of object.
(From QuestionGroupTree) number SelectCount { get; set; } - How many child items will be used for Sequence_Command_RandomizedSelect or Sequence_Command_RotateSelect
(From QuestionGroupTree) SequenceCommand constant SequenceCommand { get; set; } - Which kind of this group is it, use constant Sequence_Command_xxx
(From QuestionGroupTree) string SequenceType { get; } - Respent SequenceCommand as string
(From object) TypeInformation TypeInformation { get; } - Get information about this class.

Examples

QuestionGroupBranch is returned when calling QuestionGroupRoot_class

number qnaireRId = 15644704;
QuestionGroupRoot root = Questionnaire_getQuestionGroups(qnaireRId);
QuestionGroupBranch branch = root.FindByName("G1");
print(branch.GroupName);//G1

@@ Line 2: / Line 2: @@
 |Name=<nowiki>QuestionGroupBranch</nowiki>
 |Description=<nowiki>Question group.</nowiki>
-|InheritsFrom=QuestionGroupTree|Methods=
+|InheritsFrom=QuestionGroupTree|Constructors=
-{{CGscriptMethods_Template|ReturnType=Array of QuestionGroupTree|Name=<nowiki>GetChildGroups</nowiki>|Description=<nowiki>Return all child groups, if empty then it is a leaf.</nowiki>}}
+{{CGscriptConstructors_Template|Parameters=
+{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Group name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=QuestionnaireTemplate|Name=<nowiki>qt</nowiki>|Description=<nowiki>Questionnaire template</nowiki>}}
+|Description=<nowiki>Create a brand group</nowiki>}}
+|Methods=
+{{CGscriptMethods_Template|ReturnType=Array of QuestionGroupTree|Name=<nowiki>GetChildGroups</nowiki>|Description=<nowiki>Return all child groups.</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetChildGroups</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=Array of QuestionGroupTree|Name=<nowiki>groups</nowiki>|Description=<nowiki>Question groups</nowiki>}}
+|Description=<nowiki>Set child groups.</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 |Properties=
 {{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>AllQuestions</nowiki>|HasGetter=1|Inherited=QuestionGroupTree|Description=<nowiki>Labels of all questions in this group</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Count</nowiki>|HasGetter=1|Description=<nowiki>How many children in this group</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>GroupName</nowiki>|HasGetter=1|Inherited=QuestionGroupTree|Description=<nowiki>Name of question group</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>GroupName</nowiki>|HasGetter=1|HasSetter=1|Inherited=QuestionGroupTree|Description=<nowiki>Name of question group</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsLeaf</nowiki>|HasGetter=1|Inherited=QuestionGroupTree|Description=<nowiki>Check if it is leaf group or not</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>SequenceType</nowiki>|HasGetter=1|Inherited=QuestionGroupTree|Description=<nowiki>Which kind of question group is it</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>SelectCount</nowiki>|HasGetter=1|HasSetter=1|Inherited=QuestionGroupTree|Description=<nowiki>How many child items will be used for Sequence_Command_RandomizedSelect or Sequence_Command_RotateSelect</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=SequenceCommand constant|Name=<nowiki>SequenceCommand</nowiki>|HasGetter=1|HasSetter=1|Inherited=QuestionGroupTree|Description=<nowiki>Which kind of this group is it, use constant Sequence_Command_xxx</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>SequenceType</nowiki>|HasGetter=1|Inherited=QuestionGroupTree|Description=<nowiki>Respent SequenceCommand as string</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 }}