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

//find a group by its name
number qnaireRId = 17148177;
QuestionGroupRoot root = Questionnaire_getQuestionGroups(qnaireRId);
//QuestionGroupRoot root = new QuestionnaireTemplate(new Questionnaire(17148177).TemplateId).Groups;
QuestionGroupBranch branch = root.FindByName("G1");
print(branch.GroupName);//G1

//create new group branch 
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionGroupBranch branch = new QuestionGroupBranch ("G1", qt);
QuestionGroupLeaf leaf = qt.Groups.FindByQuestion("Q1");
branch.SetChildGroups({leaf});
//add new group to group root
array groupRoot = qt.Groups.GetChildGroups();
groupRoot.Remove(leaf);
groupRoot.Add(branch);
qt.Groups.SetChildGroups(groupRoot);
qt.Save(true);

//add more goup leaf to a group branch
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionGroupBranch branch = qt.Groups.FindByName("G1");
QuestionGroupLeaf leaf = qt.Groups.FindByQuestion("Q2");
array childGroup = branch.GetChildGroups();
childGroup.Add(leaf);//add the leaf to branch
branch.SetChildGroups(childGroup);//reset group branch
array groupRoot = qt.Groups.GetChildGroups();
groupRoot.Remove(leaf);// remove the leaf from root
qt.Groups.SetChildGroups(groupRoot);// reset group root
qt.Save(true);