CsvOptions.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="CsvOptions.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
#include "aspose.tasks.cpp/Saving/SimpleSaveOptions.h"
 
namespace Aspose
{
namespace Tasks
{
class IWriter;
namespace Saving
{
enum class CsvTextDelimiter;
class CsvWriter;
enum class DataCategory;
} // namespace Saving
namespace Visualization
{
class GanttChartColumn;
class ProjectView;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
class DateTime;
namespace Text
{
class Encoding;
} // namespace Text
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
namespace Saving {
 
/// <summary>
/// Allows to specify additional options when saving project to CSV.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS CsvOptions : public SimpleSaveOptions
{
    typedef CsvOptions ThisType;
    typedef SimpleSaveOptions BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class CsvWriter;
    
public:
 
    /// <summary>
    /// Gets a data category to be saved.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Saving::DataCategory get_DataCategory() const;
    /// <summary>
    /// Sets a data category to be saved.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_DataCategory(Aspose::Tasks::Saving::DataCategory value);
    /// <summary>
    /// Gets an encoding to save CSV with.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Text::Encoding>& get_Encoding() const;
    /// <summary>
    /// Sets an encoding to save CSV with.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Encoding(const System::SharedPtr<System::Text::Encoding>& value);
    /// <summary>
    /// Gets a value indicating whether to include headers or not (default value is TRUE).
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IncludeHeaders() const;
    /// <summary>
    /// Sets a value indicating whether to include headers or not (default value is TRUE).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_IncludeHeaders(bool value);
    /// <summary>
    /// Gets a text delimiter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API CsvTextDelimiter get_TextDelimiter() const;
    /// <summary>
    /// Sets a text delimiter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_TextDelimiter(CsvTextDelimiter value);
    /// <summary>
    /// Gets a list of the view columns (<see cref="GanttChartColumn"></see>) to save to XLSX format.
    /// If not set then default columns are saved.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Visualization::ProjectView>& get_View() const;
    /// <summary>
    /// Sets a list of the view columns (<see cref="GanttChartColumn"></see>) to save to XLSX format.
    /// If not set then default columns are saved.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_View(const System::SharedPtr<Visualization::ProjectView>& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="CsvOptions"></see> class which can be used to save project in CSV format.
    /// </summary>
    ASPOSE_TASKS_SHARED_API CsvOptions();
    
protected:
 
    ASPOSE_TASKS_SHARED_API System::String get_CostFormatLabel() const;
    ASPOSE_TASKS_SHARED_API void set_CostFormatLabel(const System::String& value);
    
    ASPOSE_TASKS_SHARED_API System::SharedPtr<IWriter> GetWriter() override;
    ASPOSE_TASKS_SHARED_API void SetView();
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Visualization::ProjectView> GetTasksScheduleView();
    
    ASPOSE_TASKS_SHARED_API virtual ~CsvOptions();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    Aspose::Tasks::Saving::DataCategory dataCategory;
    System::String pr_CostFormatLabel;
    System::SharedPtr<System::Text::Encoding> pr_Encoding;
    bool pr_IncludeHeaders;
    CsvTextDelimiter pr_TextDelimiter;
    System::SharedPtr<Visualization::ProjectView> pr_View;
    
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskIdColumn();
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskNameColumn();
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskDurationColumn();
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskStartColumn();
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskFinishColumn();
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskPercentCompleteColumn();
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskCostColumn();
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskWorkColumn();
    System::SharedPtr<Visualization::GanttChartColumn> GetTaskOutlineLevelColumn();
    System::String GetDateString(System::DateTime date);
    System::SharedPtr<Visualization::ProjectView> GetRscView();
    
};
 
} // namespace Saving
} // namespace Tasks
} // namespace Aspose