Difference between revisions of "ExportSettingsInspireFile class"
| Line 2: | Line 2: | ||
|Name=<nowiki>ExportSettingsInspireFile</nowiki> | |Name=<nowiki>ExportSettingsInspireFile</nowiki> | ||
|Description=<nowiki>Export settings for the Inspire, Trace and Sas File format.</nowiki> | |Description=<nowiki>Export settings for the Inspire, Trace and Sas File format.</nowiki> | ||
| − | |Methods= | + | |InheritsFrom=object|Methods= |
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddAllQuestions</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddAllQuestions</nowiki>|Parameters= | ||
{{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>exportToSas</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToTrace</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToInspire</nowiki>|Description=<nowiki>Export to the given format</nowiki>}} | {{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>exportToSas</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToTrace</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToInspire</nowiki>|Description=<nowiki>Export to the given format</nowiki>}} | ||
| Line 19: | Line 19: | ||
{{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>}} | {{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 true if question is exported</nowiki>}} | |Description=<nowiki>Return true if question is exported</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</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=<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=<nowiki>ExportAddressInformation</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}} | ||
| Line 31: | Line 31: | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>SasFileOptionsIncludeSasLabel</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>SasFileOptionsIncludeSasLabel</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TraceFileOptionsDuration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TraceFileOptionsDuration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} | ||
Latest revision as of 08:04, 2 July 2020
ExportSettingsInspireFile
Export settings for the Inspire, Trace and Sas File format.
Parent class
Inherits from object
Methods
- Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool exportToSas "Export to the given format", bool exportToTrace "Export to the given format", bool exportToInspire "Export to the given format") - Add all questions to the export. Default ignore GDPR classified questions.
- Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool exportToSas "Export to the given format", bool exportToTrace "Export to the given format", bool exportToInspire "Export to the given format", 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", bool exportToSas "Export to the given format", bool exportToTrace "Export to the given format", bool exportToInspire "Export to the given format") - 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
- (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 IsInspireFileFileExport { get; } - Get if exporting to specific format
- bool IsSasFileFileExport { get; } - Get if exporting to specific format
- bool IsTraceFileFileExport { get; } - Get if exporting to specific format
- string ObjectTypeName { get; } - The name of the type of object.
- bool SasFileOptionsIncludeSasLabel { get; set; } - Get/set if exporting to specific format with given option
- int TraceFileOptionsDuration { get; set; } - Get/set if exporting to specific format with given option
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Examples
string ResourceName="test ExportManager type Sas, Trace, Inspire";
number parentResourceId = 11088827;
ExportManager EM = new ExportManager (ResourceName, parentResourceId );
number questionnaireResourceId = 15546533;
EM.AddQuestionnaire(questionnaireResourceId);
ExportSettingsInspireFile exportSetting = EM.ExportSettingsInspireSasTraceFile;
bool exportToSas = true;
bool exportToTrace = true;
bool exportToInspire = true;
exportSetting.AddAllQuestions(questionnaireResourceId, exportToSas , exportToTrace , exportToInspire );
exportSetting.SasFileOptionsIncludeSasLabel = true;
exportSetting.TraceFileOptionsDuration = 1;
EM.Language ="en-GB";
DateTime startTime = new DateTime ("2017-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();
