SaveOptions.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="SaveOptions.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/date_time.h>
#include <system/array.h>
#include <drawing/size_f.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/Saving/SimpleSaveOptions.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Foundation
{
namespace Drawing
{
class DrColor;
} // namespace Drawing
} // namespace Foundation
namespace Tasks
{
class FontSettings;
class Project;
namespace Saving
{
class ApsLayoutWriter;
class HtmlSaveOptions;
class ImageSaveOptions;
class ImageWriter;
enum class LegendDrawingOptions;
class PageCountManager;
class PdfSaveOptions;
class PrintOptions;
class ReportSaveManager;
class SaveManager;
class SvgOptions;
class XamlOptions;
class XpsOptions;
} // namespace Saving
class View;
namespace Visualization
{
template <typename> class ApsBaseChartBuilder;
template <typename, typename> class ApsChartWithCalendarBuilder;
class BarStyle;
class GanttPageTaskBarBuilder;
class Gridline;
class LegendItemsFlowLayoutBuilder;
class PageLegendItem;
enum class PageSize;
enum class PresentationFormat;
class PrintManager;
class ProjectView;
class TextStyle;
enum class Timescale;
enum class TimescaleFitBehavior;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename, typename> class Dictionary;
template <typename> class List;
} // namespace Generic
} // namespace Collections
namespace Drawing
{
class Color;
} // namespace Drawing
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
namespace Saving {
 
/// <summary>
/// This is an abstract base class for classes that allow the user to specify additional options when saving a project
/// into a particular format.
/// </summary>
/// <remarks>
/// An instance of any derived class from SaveOptions class is passed to the stream Save or string Save overloads
/// for the user to define custom options when saving a document.
/// </remarks>
class ASPOSE_TASKS_SHARED_CLASS SaveOptions : public Aspose::Tasks::Saving::SimpleSaveOptions
{
    typedef SaveOptions ThisType;
    typedef Aspose::Tasks::Saving::SimpleSaveOptions BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Saving::PageCountManager;
    friend class Aspose::Tasks::Visualization::GanttPageTaskBarBuilder;
    friend class Aspose::Tasks::Visualization::LegendItemsFlowLayoutBuilder;
    friend class Aspose::Tasks::Saving::ApsLayoutWriter;
    friend class Aspose::Tasks::Saving::HtmlSaveOptions;
    friend class Aspose::Tasks::Saving::ImageSaveOptions;
    friend class Aspose::Tasks::Saving::ImageWriter;
    friend class Aspose::Tasks::Saving::PdfSaveOptions;
    friend class Aspose::Tasks::Visualization::PrintManager;
    friend class Aspose::Tasks::Saving::PrintOptions;
    friend class Aspose::Tasks::Saving::SaveManager;
    friend class Aspose::Tasks::Saving::ReportSaveManager;
    friend class Aspose::Tasks::Saving::SvgOptions;
    friend class Aspose::Tasks::Saving::XamlOptions;
    friend class Aspose::Tasks::Saving::XpsOptions;
    template<typename FT0> friend class Aspose::Tasks::Visualization::ApsBaseChartBuilder;
    template<typename FT0, typename FT1> friend class Aspose::Tasks::Visualization::ApsChartWithCalendarBuilder;
    friend class Aspose::Tasks::Visualization::ProjectView;
    
protected:
 
    class ASPOSE_TASKS_SHARED_CLASS IReduceBottomGap : public virtual System::Object
    {
        typedef IReduceBottomGap ThisType;
        typedef System::Object BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
        
    public:
    
        /// <summary>
        /// Gets a value indicating whether a gap between last task and the footer must be reduced.
        /// </summary>
        virtual bool get_ReduceFooterGap() = 0;
        
    };
    
    class ASPOSE_TASKS_SHARED_CLASS IFontCallbacks : public virtual System::Object
    {
        typedef IFontCallbacks ThisType;
        typedef System::Object BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
        
    public:
    
        virtual System::SharedPtr<Aspose::Tasks::FontSettings> get_FontSettings() = 0;
        
    };
    
    
public:
 
    /// <summary>
    /// Gets the list of the instances of the <see cref="BarStyle"></see> class that appear in project view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::BarStyle>>>& get_BarStyles() const;
    /// <summary>
    /// Sets the list of the instances of the <see cref="BarStyle"></see> class that appear in project view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_BarStyles(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::BarStyle>>>& value);
    /// <summary>
    /// Gets a value indicating whether non-working time should be drawn (Default value is TRUE).
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_DrawNonWorkingTime() const;
    /// <summary>
    /// Sets a value indicating whether non-working time should be drawn (Default value is TRUE).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_DrawNonWorkingTime(bool value);
    /// <summary>
    /// Gets a date to finish rendering to.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_EndDate() const;
    /// <summary>
    /// Sets a date to finish rendering to.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_EndDate(System::DateTime value);
    /// @deprecated This member is obsolete and will be removed after release 25.9. Please use TimescaleFitBehavior instead.
    /// <summary>
    /// Gets whether a calendar section of a view should be rendered to the end (right side) of the last page.
    /// If value is false, calendar section is rendered exactly to EndDate, even there is an empty space on a page.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_FitTimescaleToEndOfPage();
    /// @deprecated This member is obsolete and will be removed after release 25.9. Please use TimescaleFitBehavior instead.
    /// <summary>
    /// Sets whether a calendar section of a view should be rendered to the end (right side) of the last page.
    /// If value is false, calendar section is rendered exactly to EndDate, even there is an empty space on a page.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FitTimescaleToEndOfPage(bool value);
    /// <summary>
    /// Gets a behavior which define how to align right end of the timescale with the page end.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Visualization::TimescaleFitBehavior get_TimescaleFitBehavior() const;
    /// <summary>
    /// Sets a behavior which define how to align right end of the timescale with the page end.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_TimescaleFitBehavior(Aspose::Tasks::Visualization::TimescaleFitBehavior value);
    /// <summary>
    /// Gets a value indicating whether row height should be increased to fit its content.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_FitContent() const;
    /// <summary>
    /// Sets a value indicating whether row height should be increased to fit its content.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FitContent(bool value);
    /// <summary>
    /// Gets a list of <see cref="Gridline"></see> that appear in project view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::Gridline>>>& get_Gridlines() const;
    /// <summary>
    /// Sets a list of <see cref="Gridline"></see> that appear in project view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Gridlines(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::Gridline>>>& value);
    /// <summary>
    /// Gets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.
    /// </summary>
    /// <remarks>Is only applicable when Gantt chart view is rendered.</remarks>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Saving::LegendDrawingOptions get_LegendDrawingOptions() const;
    /// <summary>
    /// Sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.
    /// </summary>
    /// <remarks>Is only applicable when Gantt chart view is rendered.</remarks>
    ASPOSE_TASKS_SHARED_API void set_LegendDrawingOptions(Aspose::Tasks::Saving::LegendDrawingOptions value);
    /// <summary>
    /// Gets an array of PageLegendItem which define which bars should be rendered in page legend.
    /// If null, the default items are rendered.
    /// </summary>
    /// <remarks>Is only applicable when Gantt chart view is rendered.</remarks>
    ASPOSE_TASKS_SHARED_API const System::ArrayPtr<System::SharedPtr<Aspose::Tasks::Visualization::PageLegendItem>>& get_LegendItems() const;
    /// <summary>
    /// Sets an array of PageLegendItem which define which bars should be rendered in page legend.
    /// If null, the default items are rendered.
    /// </summary>
    /// <remarks>Is only applicable when Gantt chart view is rendered.</remarks>
    ASPOSE_TASKS_SHARED_API void set_LegendItems(const System::ArrayPtr<System::SharedPtr<Aspose::Tasks::Visualization::PageLegendItem>>& value);
    /// <summary>
    /// Gets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_MarkCriticalTasks() const;
    /// <summary>
    /// Sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MarkCriticalTasks(bool value);
    /// <summary>
    /// Gets the non-working time color.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Drawing::Color get_NonWorkingTimeColor();
    /// <summary>
    /// Sets the non-working time color.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_NonWorkingTimeColor(System::Drawing::Color value);
    /// <summary>
    /// Gets the number of pages of project.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_PageCount() const;
    /// <summary>
    /// Gets the size of page to be rendered (Default value is PageSize.A4).
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Visualization::PageSize get_PageSize() const;
    /// <summary>
    /// Sets the size of page to be rendered (Default value is PageSize.A4).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_PageSize(Aspose::Tasks::Visualization::PageSize value);
    /// <summary>
    /// Gets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.
    /// </summary>
    /// <remarks>Is not applicable when SaveOptions.PageSize == Visualization.PageSize.DefinedInView.
    /// In this case View.PageInfo.PageSettings.IsPortrait is used instead.
    /// Is not applicable when SaveOptions.CustomPageSize is set.</remarks>
    ASPOSE_TASKS_SHARED_API bool get_IsPortrait() const;
    /// <summary>
    /// Sets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.
    /// </summary>
    /// <remarks>Is not applicable when SaveOptions.PageSize == Visualization.PageSize.DefinedInView.
    /// In this case View.PageInfo.PageSettings.IsPortrait is used instead.
    /// Is not applicable when SaveOptions.CustomPageSize is set.</remarks>
    ASPOSE_TASKS_SHARED_API void set_IsPortrait(bool value);
    /// <summary>
    /// Gets the <see cref="PresentationFormat"></see> in which the document will be saved.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Visualization::PresentationFormat get_PresentationFormat() const;
    /// <summary>
    /// Sets the <see cref="PresentationFormat"></see> in which the document will be saved.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_PresentationFormat(Aspose::Tasks::Visualization::PresentationFormat value);
    /// <summary>
    /// Gets a value indicating whether subtasks on the summary task bar should be marked.
    /// For subtasks, the Rollup field indicates whether information on the subtask Gantt bars will be rolled up to the summary task bar.
    /// For summary tasks, the Rollup field indicates whether the summary task bar displays rolled up bars.
    /// You must have the Rollup field for summary tasks set to Yes for any subtasks to roll up to them. 
    /// </summary>
    /// <remarks>Is only applicable when Gantt chart view is rendered.</remarks>
    ASPOSE_TASKS_SHARED_API bool get_RollUpGanttBars() const;
    /// <summary>
    /// Sets a value indicating whether subtasks on the summary task bar should be marked.
    /// For subtasks, the Rollup field indicates whether information on the subtask Gantt bars will be rolled up to the summary task bar.
    /// For summary tasks, the Rollup field indicates whether the summary task bar displays rolled up bars.
    /// You must have the Rollup field for summary tasks set to Yes for any subtasks to roll up to them. 
    /// </summary>
    /// <remarks>Is only applicable when Gantt chart view is rendered.</remarks>
    ASPOSE_TASKS_SHARED_API void set_RollUpGanttBars(bool value);
    /// <summary>
    /// Gets the date to start rendering from.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_StartDate() const;
    /// <summary>
    /// Sets the date to start rendering from.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StartDate(System::DateTime value);
    /// <summary>
    /// Gets the list of text styles that applied during rendering of a project view.
    /// </summary>
    /// <remarks>These styles override styles defined in GanttCharView.TextStyles.</remarks>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::TextStyle>>>& get_TextStyles() const;
    /// <summary>
    /// Sets the list of text styles that applied during rendering of a project view.
    /// </summary>
    /// <remarks>These styles override styles defined in GanttCharView.TextStyles.</remarks>
    ASPOSE_TASKS_SHARED_API void set_TextStyles(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::TextStyle>>>& value);
    /// <summary>
    /// Gets the <see cref="Timescale"></see> value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Visualization::Timescale get_Timescale() const;
    /// <summary>
    /// Sets the <see cref="Timescale"></see> value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Timescale(Aspose::Tasks::Visualization::Timescale value);
    /// <summary>
    /// Gets a value indicating whether gradient brush should be used when rendering Gantt Chart.
    /// </summary>
    /// <remarks>Is only applicable when Gantt chart view is rendered.</remarks>
    virtual ASPOSE_TASKS_SHARED_API bool get_UseGradientBrush();
    /// <summary>
    /// Sets a value indicating whether gradient brush should be used when rendering Gantt Chart.
    /// </summary>
    /// <remarks>Is only applicable when Gantt chart view is rendered.</remarks>
    virtual ASPOSE_TASKS_SHARED_API void set_UseGradientBrush(bool value);
    /// <summary>
    /// Gets a list of the view columns to render (<see cref="GanttChartColumn"></see>).
    /// If not set then task ids, task names, start and finish are rendered only.
    /// If both View and <see cref="ViewSettings"></see> properties are set, columns from View overrides columns from ViewSettings.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::Visualization::ProjectView> get_View();
    /// <summary>
    /// Sets a list of the view columns to render (<see cref="GanttChartColumn"></see>).
    /// If not set then task ids, task names, start and finish are rendered only.
    /// If both View and <see cref="ViewSettings"></see> properties are set, columns from View overrides columns from ViewSettings.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_View(const System::SharedPtr<Aspose::Tasks::Visualization::ProjectView>& value);
    /// <summary>
    /// Gets a view (<see cref="View"></see>) to render. You can use this options to explicitly specify which view should be saved to PDF, HTML or Image formats.
    /// If this property is set, <see cref="Visualization::PresentationFormat"></see> property is ignored when project is saved.
    /// View should be from one of the following screen ((<see cref="Aspose::Tasks::View::Screen"></see>)): (Gantt, TaskSheet, TaskUsage, ResourceSheet, ResourceUsage) 
    /// </summary>
    /// <exception cref="ArgumentException">When set method is called and instance of View class with not supported value of Screen property is provided.</exception>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::View> get_ViewSettings() const;
    /// <summary>
    /// Sets a view (<see cref="View"></see>) to render. You can use this options to explicitly specify which view should be saved to PDF, HTML or Image formats.
    /// If this property is set, <see cref="Visualization::PresentationFormat"></see> property is ignored when project is saved.
    /// View should be from one of the following screen ((<see cref="Aspose::Tasks::View::Screen"></see>)): (Gantt, TaskSheet, TaskUsage, ResourceSheet, ResourceUsage) 
    /// </summary>
    /// <exception cref="ArgumentException">When set method is called and instance of View class with not supported value of Screen property is provided.</exception>
    ASPOSE_TASKS_SHARED_API void set_ViewSettings(const System::SharedPtr<Aspose::Tasks::View>& value);
    /// <summary>
    /// Gets the custom page size in points (1 point = 1/72 of inch).
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Drawing::SizeF get_CustomPageSize() const;
    /// <summary>
    /// Sets the custom page size in points (1 point = 1/72 of inch).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_CustomPageSize(System::Drawing::SizeF value);
    /// <summary>
    /// Gets a value indicating whether a project should be rendered to a single page
    /// when project is saved in graphical format.
    /// The page size will be changed so the rendered project can be fit on one page.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_RenderToSinglePage() const;
    /// <summary>
    /// Sets a value indicating whether a project should be rendered to a single page
    /// when project is saved in graphical format.
    /// The page size will be changed so the rendered project can be fit on one page.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RenderToSinglePage(bool value);
    
protected:
 
    /// <summary>
    /// Sets the number of pages of project.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_PageCount(int32_t value);
    /// <summary>
    /// Gets the project to save.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::Project> get_Project() override;
    /// <summary>
    /// Sets the project to save.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Project(System::SharedPtr<Aspose::Tasks::Project> value) override;
    
    /// <summary>
    /// Initializes a new instance of the <see cref="SaveOptions"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API SaveOptions();
    /// <summary>
    /// Initializes a new instance of the <see cref="SaveOptions"></see> class.
    /// </summary>
    /// <param name="options">The <see cref="SaveOptions"></see> to copy.</param>
    ASPOSE_TASKS_SHARED_API SaveOptions(const System::SharedPtr<SaveOptions>& options);
    
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Foundation::Drawing::DrColor> GetNonworkingTimeColor();
    ASPOSE_TASKS_SHARED_API void SetPageCount(int32_t count);
    virtual ASPOSE_TASKS_SHARED_API System::Drawing::SizeF GetPageSize();
    virtual ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::Visualization::ProjectView> GetDefaultProjectView();
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    static System::SharedPtr<System::Collections::Generic::Dictionary<System::String, Aspose::Tasks::Visualization::PresentationFormat>>& Views();
    
    System::SharedPtr<Aspose::Foundation::Drawing::DrColor> nonWorkingTimeColor;
    bool useGradientBrush;
    System::SharedPtr<Aspose::Tasks::Visualization::ProjectView> view;
    System::SharedPtr<Aspose::Tasks::View> viewSettings;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::BarStyle>>> pr_BarStyles;
    bool pr_DrawNonWorkingTime;
    System::DateTime pr_EndDate;
    Aspose::Tasks::Visualization::TimescaleFitBehavior pr_TimescaleFitBehavior;
    bool pr_FitContent;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::Gridline>>> pr_Gridlines;
    Aspose::Tasks::Saving::LegendDrawingOptions pr_LegendDrawingOptions;
    System::ArrayPtr<System::SharedPtr<Aspose::Tasks::Visualization::PageLegendItem>> pr_LegendItems;
    bool pr_MarkCriticalTasks;
    int32_t pr_PageCount;
    Aspose::Tasks::Visualization::PageSize pr_PageSize;
    bool pr_IsPortrait;
    Aspose::Tasks::Visualization::PresentationFormat pr_PresentationFormat;
    bool pr_RollUpGanttBars;
    System::DateTime pr_StartDate;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::TextStyle>>> pr_TextStyles;
    Aspose::Tasks::Visualization::Timescale pr_Timescale;
    System::Drawing::SizeF pr_CustomPageSize;
    bool pr_RenderToSinglePage;
    
    static System::SharedPtr<System::Collections::Generic::Dictionary<System::String, Aspose::Tasks::Visualization::PresentationFormat>> InitViewsTable();
    void SetDefaultPresentationFormat();
    
};
 
} // namespace Saving
} // namespace Tasks
} // namespace Aspose