Latest revision as of 05:25, 2 July 2020

GroupBuilderOptionDataVariable

Represents a group builder variable for specific option answers to a question.

Parent class

Inherits from GroupBuilderVariable

Constructors

() - Create new variable

Methods

(From object) string ToString() - The string representation of the object.

Properties

bool IncludeSpecificAnswer { get; set; } - Include answers, or include those that did not answer
bool IncludeTestUsers { get; set; } - Include answers from test
string ObjectTypeName { get; } - The name of the type of object.
array Options { get; set; } - Include answers answers to specific answer options
string QuestionLabel { get; set; } - Question to search answers from
int QuestionnaireResourceId { get; set; } - Questionnaire to get users from
int SubQuestionGridNumber { get; set; } - Question to search answers from
(From object) TypeInformation TypeInformation { get; } - Get information about this class.

Examples

//Create a new group
string groupName = "Test Group Builder: optionDataVariable ";
number groupTemplateResourceId=2066;
number parentResourceId = 11088827;
array group = Group_new(groupName, groupTemplateResourceId, parentResourceId);
Group_save(group);
number groupRId = group[GROUP_RESOURCE_ID ];
 
//Create rule for the group
GroupBuilderRoot root = new GroupBuilderRoot (groupRId);

GroupBuilderOptionDataVariable optionDataVariable = new GroupBuilderOptionDataVariable();
optionDataVariable.QuestionnaireResourceId = 15546533;
optionDataVariable.QuestionLabel="Q7";
optionDataVariable.SubQuestionGridNumber=0;
optionDataVariable.Options={1,2};
optionDataVariable.IncludeTestUsers = true;
optionDataVariable.IncludeSpecificAnswer =true;
 
GroupBuilderRule rule = new GroupBuilderRule (root);
rule.Add(optionDataVariable);
 
GroupBuilderRuleCollection ruleColection = root.RootRules;
ruleColection.Add(rule);

root.Save();

@@ Line 1: / Line 1: @@
 {{CGscriptClass_Template
-|Name=GroupBuilderOptionDataVariable
+|Name=<nowiki>GroupBuilderOptionDataVariable</nowiki>
-|Description=Represents a group builder variable for specific option answers to a question.
+|Description=<nowiki>Represents a group builder variable for specific option answers to a question.</nowiki>
-|Constructors=
+|InheritsFrom=GroupBuilderVariable|Constructors=
-{{CGscriptConstructors_Template|Description=Create new variable}}
+{{CGscriptConstructors_Template|Description=<nowiki>Create new variable</nowiki>}}
 |Methods=
-{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
+{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 |Properties=
-{{CGscriptProperties_Template|ReturnType=bool|Name=IncludeSpecificAnswer|HasGetter=1|HasSetter=1|Description=Include answers, or include those that did not answer}}
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IncludeSpecificAnswer</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Include answers, or include those that did not answer</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=bool|Name=IncludeTestUsers|HasGetter=1|HasSetter=1|Description=Include answers from test}}
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IncludeTestUsers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Include answers from test</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
+{{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=Options|HasGetter=1|HasSetter=1|Description=Include answers answers to specific answer options}}
+{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Options</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Include answers answers to specific answer options</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=string|Name=QuestionLabel|HasGetter=1|HasSetter=1|Description=Question to search answers from}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QuestionLabel</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Question to search answers from</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=int|Name=QuestionnaireResourceId|HasGetter=1|HasSetter=1|Description=Questionnaire to get users from}}
+{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire to get users from</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=int|Name=SubQuestionGridNumber|HasGetter=1|HasSetter=1|Description=Question to search answers from}}
+{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SubQuestionGridNumber</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Question to search answers from</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 }}
+=== <span style="color:#DF8621">'''Examples'''</span> ===
+<source lang="javascript">
+//Create a new group
+string groupName = "Test Group Builder: optionDataVariable ";
+number groupTemplateResourceId=2066;
+number parentResourceId = 11088827;
+array group = Group_new(groupName, groupTemplateResourceId, parentResourceId);
+Group_save(group);
+number groupRId = group[GROUP_RESOURCE_ID ];
+//Create rule for the group
+GroupBuilderRoot root = new GroupBuilderRoot (groupRId);
+GroupBuilderOptionDataVariable optionDataVariable = new GroupBuilderOptionDataVariable();
+optionDataVariable.QuestionnaireResourceId = 15546533;
+optionDataVariable.QuestionLabel="Q7";
+optionDataVariable.SubQuestionGridNumber=0;
+optionDataVariable.Options={1,2};
+optionDataVariable.IncludeTestUsers = true;
+optionDataVariable.IncludeSpecificAnswer =true;
+GroupBuilderRule rule = new GroupBuilderRule (root);
+rule.Add(optionDataVariable);
+GroupBuilderRuleCollection ruleColection = root.RootRules;
+ruleColection.Add(rule);
+root.Save();
+</source>