Difference between revisions of "ExportSettingsTripleSFile class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=ExportSettingsTripleSFile |Description=Export settings for the TripleS File format. |Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=A...")
 
Line 29: Line 29:
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
}}
 
}}
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
<source lang="javascript">
 +
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();
 +
</source>

Revision as of 08:06, 24 April 2017

ExportSettingsTripleSFile



Export settings for the TripleS File format.


Methods

  • Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in") - 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
  • 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.
  • 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();