ExportSettingsExcelCsvFile class

ExportSettingsExcelCsvFile

Export settings for the Excel and Csv File format.

Parent class

Inherits from object

Methods

• Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool presentAsText "Export the option as the value or as the text", bool optionsAsMultipleColumns "Export the options as multiple columns", bool exportToCsv "Export to the given format", bool exportToExcel "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 presentAsText "Export the option as the value or as the text", bool optionsAsMultipleColumns "Export the options as multiple columns", bool exportToCsv "Export to the given format", bool exportToExcel "Export to the given format", bool includeQuestionWithGDPRDate "Include questions marked as containing GDPR classified data") - Add all questions to the export
  
• Empty AddAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool presentAsText "Export the option as the value or as the text", bool exportToCsv "Export to the given format", bool exportToExcel "Export to the given format") - 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", bool presentAsText "Export the option as the value or as the text", bool optionAsMultipleColumns "Export the options as multiple columns", bool exportToCsv "Export to the given format", bool exportToExcel "Export to the given format") - Add question to the export
  
• Empty AddQuestion(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question", bool presentAsText "Export the option as the value or as the text", bool exportToCsv "Export to the given format", bool exportToExcel "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
  
• bool OptionsAsMultipleColumns(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return OptionsAsMultipleColumns of question in export
  
• bool PresentAsText(int questionnaireResourceId "The questionnaire the question is located in", string questionLabel "Label of the question") - Return PresentAsText of question in export
  
• Empty SetExportOptionsAsMultipleColumnsForAllQuestions(int questionnaireResourceId "The questionnaire the question is located in", bool optionValue "Option value (true/false)") - Set value of the OptionsAsMultipleColumns option for all questions whose type is Multi or MultiGrid
  
• (From object) string ToString() - The string representation of the object.
  

Properties

• bool CsvFileOptionsUseCommaSeparatedFormat { get; set; } - Get/set if exporting to specific format with given option
  
• bool ExcelFileOptionsAddQuestionText { get; set; } - Get/set if add question text to the file is enable
  
• bool ExcelFileOptionsUseCommaSeparatedFormat { get; set; } - Get/set if exporting to specific format with given option
  
• 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 IsCsvFileExport { get; } - Get if exporting to specific format
  
• bool IsExcelFileExport { 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

//********** Example for making an export to excel ************//
string ResourceName="test ExportManager type excel";
number parentResourceId = 11088827;
ExportManager EM = new ExportManager (ResourceName, parentResourceId );
EM.AddQuestionnaire(15546533);
ExportSettingsExcelCsvFile exportSetting = EM.ExportSettingsExcelCsvFile;
number questionnaireResourceId = 15546533;
bool presentAsText = false;
bool exportToCsv = false;
bool exportToExcel = true;
exportSetting.AddAllQuestions(questionnaireResourceId, presentAsText, exportToCsv, exportToExcel );
exportSetting.ExcelFileOptionsUseCommaSeparatedFormat = true;
EM.Language ="en-GB";
exportSetting.ExportAddressInformation= true;
exportSetting.ExportPhoneNumbers = true;
exportSetting.ExportUserAccountInformation = true;
exportSetting.ExportUserEmail = true;
//exportSetting.IsExcelFileExport = true;
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 = true;
EM.QasPartly = true;
EM.QasCompleted = true;
EM.QasNormal = true;
EM.QasQuotaFull = true;
EM.QasOutsideTarget = true;
EM.QasInterviewFailed = true;
EM.QasInterviewSucceded = true;
EM.IncludedTestData= false;
EM.IncludedDeletedUsers = true;
EM.IncludedDisabledUsers = false;
EM.Save();
EM.Export();

//********** Example with export question type multi to separate columns ************//
string ResourceName="Export Excel multi cols Q3";
number parentResourceId = 770747;
ExportManager EM= new ExportManager (ResourceName, parentResourceId );
//ExportManager EM = new ExportManager (2947148);
//EM.Reset();
EM.AddQuestionnaire(2641061);
ExportSettingsExcelCsvFile exportSetting = EM.ExportSettingsExcelCsvFile;
number questionnaireResourceId = 2641061;
string questionLabel = "Q3";
bool presentAsText = false;
bool optionsAsMultipleColumns = true;
bool exportToCsv = false;
bool exportToExcel = true;
exportSetting.AddQuestion(questionnaireResourceId, questionLabel, presentAsText, optionsAsMultipleColumns, exportToCsv, exportToExcel );
//exportSetting.AddAllQuestions(questionnaireResourceId, presentAsText, exportToCsv, exportToExcel );
exportSetting.ExcelFileOptionsUseCommaSeparatedFormat = false;
EM.Language ="en-GB";
exportSetting.ExportAddressInformation= false;
exportSetting.ExportPhoneNumbers = false;
exportSetting.ExportUserAccountInformation = false;
exportSetting.ExportUserEmail = false;
EM.QasNotStarted = true;
EM.QasPartly = true;
EM.QasCompleted = true;
EM.QasNormal = true;
EM.QasQuotaFull = true;
EM.QasOutsideTarget = true;
EM.QasInterviewFailed = true;
EM.QasInterviewSucceded = true;
EM.IncludedTestData= false;
EM.IncludedDeletedUsers = false;
EM.IncludedDisabledUsers = false;
EM.Save();
//EM.Export();