MPPSaveOptions.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="MPPSaveOptions.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
 
#include "aspose.tasks.cpp/Saving/SimpleSaveOptions.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class IWriter;
class Project;
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
namespace Saving {
 
/// <summary>
/// Allows to specify additional options when saving project data to MPP.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS MPPSaveOptions : public Aspose::Tasks::Saving::SimpleSaveOptions
{
    typedef MPPSaveOptions ThisType;
    typedef Aspose::Tasks::Saving::SimpleSaveOptions BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
public:
 
    /// <summary>
    /// Gets a value indicating whether to remove invalid resource assignments when saving to MPP.
    /// <remarks>MS Project creates an empty resource assignment for each task. Set this flag to true to remove them on save.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_RemoveInvalidAssignments() const;
    /// <summary>
    /// Sets a value indicating whether to remove invalid resource assignments when saving to MPP.
    /// <remarks>MS Project creates an empty resource assignment for each task. Set this flag to true to remove them on save.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RemoveInvalidAssignments(bool value);
    /// <summary>
    /// Gets a value indicating whether to write view data when saving a project to MPP format.
    /// <remarks>View data includes Project.Views, Filters and Tables collections.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_WriteViewData() const;
    /// <summary>
    /// Sets a value indicating whether to write view data when saving a project to MPP format.
    /// <remarks>View data includes Project.Views, Filters and Tables collections.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_WriteViewData(bool value);
    /// <summary>
    /// Gets a value indicating whether to write filter data when saving a project to MPP for format.
    /// <remarks>Filter data includes Project.TaskFilters and Project.ResourceFilters collections.</remarks>
    /// </summary>
    /// <remarks>Currently supported for MSP 2010 or newer formats.</remarks>
    ASPOSE_TASKS_SHARED_API bool get_WriteFilters() const;
    /// <summary>
    /// Sets a value indicating whether to write filter data when saving a project to MPP for format.
    /// <remarks>Filter data includes Project.TaskFilters and Project.ResourceFilters collections.</remarks>
    /// </summary>
    /// <remarks>Currently supported for MSP 2010 or newer formats.</remarks>
    ASPOSE_TASKS_SHARED_API void set_WriteFilters(bool value);
    /// <summary>
    /// Gets a value indicating whether to write groups data when saving a project to MPP for format.
    /// <remarks>Group data includes Project.TaskGroups and Project.ResourceGroups collections.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_WriteGroups() const;
    /// <summary>
    /// Sets a value indicating whether to write groups data when saving a project to MPP for format.
    /// <remarks>Group data includes Project.TaskGroups and Project.ResourceGroups collections.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_WriteGroups(bool value);
    /// <summary>
    /// Gets a value indicating whether to remove existing VBA macros data when saving a project to MPP format.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_ClearVba() const;
    /// <summary>
    /// Sets a value indicating whether to remove existing VBA macros data when saving a project to MPP format.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ClearVba(bool value);
    /// <summary>
    /// Gets a value indicating whether to update existing VBA macros data in MPP file.
    /// Currently writing of VbaModule.SourceCode is supported.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_WriteVba() const;
    /// <summary>
    /// Sets a value indicating whether to update existing VBA macros data in MPP file.
    /// Currently writing of VbaModule.SourceCode is supported.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_WriteVba(bool value);
    /// <summary>
    /// Gets a password which is used to protect a resulting MPP file. Currently is supported for MS Project 2010 and newer formats.
    /// <remarks>Null value indicates that the project file is not protected.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_ProtectionPassword() const;
    /// <summary>
    /// Sets a password which is used to protect a resulting MPP file. Currently is supported for MS Project 2010 and newer formats.
    /// <remarks>Null value indicates that the project file is not protected.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ProtectionPassword(const System::String& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="MPPSaveOptions"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API MPPSaveOptions();
    
protected:
 
    ASPOSE_TASKS_SHARED_API System::SharedPtr<IWriter> GetWriter() override;
    
    virtual ASPOSE_TASKS_SHARED_API ~MPPSaveOptions();
    
private:
 
    bool pr_RemoveInvalidAssignments;
    bool pr_WriteViewData;
    bool pr_WriteFilters;
    bool pr_WriteGroups;
    bool pr_ClearVba;
    bool pr_WriteVba;
    System::String pr_ProtectionPassword;
    
    System::SharedPtr<IWriter> GetWriter(const System::SharedPtr<Aspose::Tasks::Project>& project);
    void UpdateProjectFileSystem();
    
};
 
} // namespace Saving
} // namespace Tasks
} // namespace Aspose