Difference between revisions of "ExportSettingsAsciiFile class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=ExportSettingsAsciiFile |Description=Export settings for the Ascii File format. |Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=Clear...")
 
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=ExportSettingsAsciiFile
+
|Name=<nowiki>ExportSettingsAsciiFile</nowiki>
|Description=Export settings for the Ascii File format.
+
|Description=<nowiki>Export settings for the Ascii File format.</nowiki>
|Methods=
+
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Clear|Description=Remove format from output}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Clear</nowiki>|Description=<nowiki>Remove format from output</nowiki>}}
{{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=
 
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=AsciiFileOptionAlternativeChars|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AsciiFileOptionAlternativeChars</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=AsciiFileOptionIncludeSummaryFile|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AsciiFileOptionIncludeSummaryFile</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=AsciiFileOptionSeparatorChar|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AsciiFileOptionSeparatorChar</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=AsciiFileOptionUseSeparatedFormat|HasGetter=1|HasSetter=1|Description=Get/set if exporting to specific format with given option}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AsciiFileOptionUseSeparatedFormat</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if exporting to specific format with given option</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsAsciiFileExport|HasGetter=1|Description=Get if exporting to specific format}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsAsciiFileExport</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> ===
 +
<source lang="javascript">
 +
string ResourceName="test ExportManager type AsciiFile";
 +
number parentResourceId = 11088827;
 +
ExportManager EM = new ExportManager (ResourceName, parentResourceId );
 +
number questionnaireResourceId  = 15546533;
 +
EM.AddQuestionnaire(questionnaireResourceId);
 +
ExportSettingsAsciiFile exportSetting = EM.ExportSettingsAsciiFile;
 +
exportSetting.AsciiFileOptionAlternativeChars="1/0";
 +
exportSetting.AsciiFileOptionIncludeSummaryFile = true;
 +
//exportSetting.AsciiFileOptionSeparatorChar = ";";
 +
//exportSetting.AsciiFileOptionUseSeparatedFormat = true;
 +
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>

Latest revision as of 08:03, 2 July 2020

ExportSettingsAsciiFile



Export settings for the Ascii File format.

Parent class

Inherits from object

Methods

  • Empty Clear() - Remove format from output
  • (From object) string ToString() - The string representation of the object.

Properties

  • string AsciiFileOptionAlternativeChars { get; set; } - Get/set if exporting to specific format with given option
  • bool AsciiFileOptionIncludeSummaryFile { get; set; } - Get/set if exporting to specific format with given option
  • string AsciiFileOptionSeparatorChar { get; set; } - Get/set if exporting to specific format with given option
  • bool AsciiFileOptionUseSeparatedFormat { get; set; } - Get/set if exporting to specific format with given option
  • bool IsAsciiFileExport { 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 AsciiFile";
number parentResourceId = 11088827;
ExportManager EM = new ExportManager (ResourceName, parentResourceId ); 
number questionnaireResourceId  = 15546533;
EM.AddQuestionnaire(questionnaireResourceId); 
ExportSettingsAsciiFile exportSetting = EM.ExportSettingsAsciiFile;
exportSetting.AsciiFileOptionAlternativeChars="1/0";
exportSetting.AsciiFileOptionIncludeSummaryFile = true;
//exportSetting.AsciiFileOptionSeparatorChar = ";";
//exportSetting.AsciiFileOptionUseSeparatedFormat = true;
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();