Difference between revisions of "ExportSettingsTripleSFile class"

From Catglobe Wiki
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
−
|Name=ExportSettingsTripleSFile
+
|Name=<nowiki>ExportSettingsTripleSFile</nowiki>
−
|Description=Export settings for the TripleS File format.
+
|Description=<nowiki>Export settings for the TripleS File format.</nowiki>
−
|Methods=
+
|InheritsFrom=object|Methods=
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddAllQuestions|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddAllQuestions</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>}}
−
|Description=Add all questions to the export}}
+
|Description=<nowiki>Add all questions to the export. Default ignore GDPR classified questions.</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddQuestion|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddAllQuestions</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=questionLabel|Description=Label of the question|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=length|Description=Length of export field, if set to 0 autodetect}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>includeQuestionWithGDPRDate</nowiki>|Description=<nowiki>Include questions marked as containing GDPR classified data</nowiki>}}
−
|Description=Add question to the export}}
+
|Description=<nowiki>Add all questions to the export</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=Clear|Description=Remove format from output}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddQuestion</nowiki>|Parameters=
−
{{CGscriptMethods_Template|ReturnType=int|Name=GridIndex|Parameters=
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>length</nowiki>|Description=<nowiki>Length of export field, if set to 0 autodetect</nowiki>}}
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=questionLabel|Description=Label of the question}}
+
|Description=<nowiki>Add question to the export</nowiki>}}
−
|Description=Return GridIndex of question in export}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Clear</nowiki>|Description=<nowiki>Remove format from output</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=bool|Name=IsQuestionExported|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>GridIndex</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=questionLabel|Description=Label of the question}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question</nowiki>}}
−
|Description=Return true if question is exported}}
+
|Description=<nowiki>Return GridIndex of question in export</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=Length|Parameters=
+
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsQuestionExported</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=questionnaireResourceId|Description=The questionnaire the question is located in|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=questionLabel|Description=Label of the question}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question</nowiki>}}
−
|Description=Return Length of question in export}}
+
|Description=<nowiki>Return true if question is exported</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Length</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>The questionnaire the question is located in</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question</nowiki>}}
 +
|Description=<nowiki>Return Length of question in export</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
−
{{CGscriptProperties_Template|ReturnType=bool|Name=ExportAddressInformation|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ExportAddressInformation</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=ExportPhoneNumbers|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ExportPhoneNumbers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=ExportUserAccountInformation|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ExportUserAccountInformation</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=ExportUserEmail|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ExportUserEmail</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=IsTripleSFileFileExport|HasGetter=1|Description=Get if exporting to specific format}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsTripleSFileFileExport</nowiki>|HasGetter=1|Description=<nowiki>Get if exporting to specific format</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=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> ===
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
<source lang="javascript">
 
<source lang="javascript">

Latest revision as of 08:08, 2 July 2020

ExportSettingsTripleSFile



Export settings for the TripleS File format.

Parent class

Inherits from object

Methods

  • Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in") - Add all questions to the export. Default ignore GDPR classified questions.
  • Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool includeQuestionWithGDPRDate "Include questions marked as containing GDPR classified data") - Add all questions to the export
  • Empty AddQuestion(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question", int length "Length of export field, if set to 0 autodetect") - Add question to the export
  • Empty Clear() - Remove format from output
  • int GridIndex(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return GridIndex of question in export
  • bool IsQuestionExported(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return true if question is exported
  • int Length(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return Length of question in export
  • (From object) string ToString() - The string representation of the object.

Properties

  • bool ExportAddressInformation { get; set; } - Get/set if exporting to specific format with given option
  • bool ExportPhoneNumbers { get; set; } - Get/set if exporting to specific format with given option
  • bool ExportUserAccountInformation { get; set; } - Get/set if exporting to specific format with given option
  • bool ExportUserEmail { get; set; } - Get/set if exporting to specific format with given option
  • bool IsTripleSFileFileExport { get; } - Get if exporting to specific format
  • string ObjectTypeName { get; } - The name of the type of object.
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.


Examples

string ResourceName="test ExportManager type TripleSFile";
number parentResourceId = 11088827;
ExportManager EM = new ExportManager (ResourceName, parentResourceId ); 
number questionnaireResourceId  = 15546533;
EM.AddQuestionnaire(questionnaireResourceId); 
ExportSettingsTripleSFile  exportSetting = EM.ExportSettingsTripleSFile ;
exportSetting.AddAllQuestions(questionnaireResourceId);
EM.Language ="en-GB"; 
DateTime startTime = new DateTime ("2016-4-18");
DateTime endTime = new DateTime ("2017-4-19");
EM.SelectTimeFrame =true;
EM.CGStartTimeFrameUTC = startTime;
EM.CGEndTimeFrameUTC = endTime; 
EM.QasNotStarted = false;
EM.QasPartly = false;
EM.QasCompleted = true; 
EM.QasNormal = true;
EM.QasQuotaFull = false;
EM.QasOutsideTarget = false;
EM.QasInterviewFailed = false;
EM.QasInterviewSucceded = true; 
EM.IncludedTestData= false;
EM.IncludedDeletedUsers = false;
EM.IncludedDisabledUsers = false;
EM.Save();
EM.Export();
Retrieved from "http://wiki.catglobe.com/index.php?title=ExportSettingsTripleSFile_class&oldid=239703"