Difference between revisions of "ExportSettingsNipoFile class"
| Line 2: | Line 2: | ||
|Name=<nowiki>ExportSettingsNipoFile</nowiki> | |Name=<nowiki>ExportSettingsNipoFile</nowiki> | ||
|Description=<nowiki>Export settings for the 3 Nipo File formats.</nowiki> | |Description=<nowiki>Export settings for the 3 Nipo File formats.</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>exportToOFile</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToUFile</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToQFile</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>exportToOFile</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToUFile</nowiki>|Description=<nowiki>Export to the given format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>exportToQFile</nowiki>|Description=<nowiki>Export to the given format</nowiki>}} | ||
| Line 25: | Line 25: | ||
{{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 Position of question in export</nowiki>}} | |Description=<nowiki>Return Position of question in export</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>IsNipoOFileExport</nowiki>|HasGetter=1|Description=<nowiki>Get if exporting to specific format</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsNipoOFileExport</nowiki>|HasGetter=1|Description=<nowiki>Get if exporting to specific format</nowiki>}} | ||
| Line 31: | Line 31: | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsNipoUFileExport</nowiki>|HasGetter=1|Description=<nowiki>Get if exporting to specific format</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsNipoUFileExport</nowiki>|HasGetter=1|Description=<nowiki>Get if exporting to specific format</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{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=<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:05, 2 July 2020
ExportSettingsNipoFile
Export settings for the 3 Nipo File formats.
Parent class
Inherits from object
Methods
- Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool exportToOFile "Export to the given format", bool exportToUFile "Export to the given format", bool exportToQFile "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 exportToOFile "Export to the given format", bool exportToUFile "Export to the given format", bool exportToQFile "Export to the given format", bool includeQuestionWithGDPRDate "Include questions marked as containing GDPR classified data") - Add all questions to the export. Default ignore GDPR classified questions.
- 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", bool exportToOFile "Export to the given format", bool exportToUFile "Export to the given format", bool exportToQFile "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
- int Length(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return Length of question in export
- int Position(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return Position of question in export
- (From object) string ToString() - The string representation of the object.
Properties
- bool IsNipoOFileExport { get; } - Get if exporting to specific format
- bool IsNipoQFileExport { get; } - Get if exporting to specific format
- bool IsNipoUFileExport { 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 OFile, UFile, QFile";
number parentResourceId = 11088827;
ExportManager EM = new ExportManager (ResourceName, parentResourceId );
number questionnaireResourceId = 15546533;
EM.AddQuestionnaire(questionnaireResourceId);
ExportSettingsNipoFile exportSetting = EM.ExportSettingsNipoFile;
bool exportToOFile = true;
bool exportToUFile = true;
bool exportToQFile = true;
exportSetting.AddAllQuestions(questionnaireResourceId, exportToOFile, exportToUFile, exportToQFile);
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();
