LoadOptions.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="LoadOptions.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------

#include <system/string.h>

#include "aspose.tasks.cpp/IO/Xml/ParseErrorCallback.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"

namespace Aspose
{
namespace LicenseV2
{
namespace Venture
{
class VentureLicense;
} // namespace Venture
} // namespace LicenseV2
namespace Tasks
{
class ICancellationTracker;
class ParseErrorArgs;
class PrimaveraBaseReader;
class PrimaveraReadOptions;
class Project;
class ProjectReader;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Text
{
class Encoding;
} // namespace Text
} // namespace System

namespace Aspose {

namespace Tasks {

/// <summary>
/// Allows to specify additional load parameters when loading a project from file or stream.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS LoadOptions : public System::Object
{
    typedef LoadOptions ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::PrimaveraBaseReader;
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::ProjectReader;
    
public:

    /// <summary>
    /// Gets a callback method to handle xml parse errors.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ParseErrorCallback get_ErrorHandler() const;
    /// <summary>
    /// Sets a callback method to handle xml parse errors.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ErrorHandler(ParseErrorCallback value);
    /// <summary>
    /// Gets a protection password.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Password() const;
    /// <summary>
    /// Sets a protection password.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Password(const System::String& value);
    /// <summary>
    /// Gets a specified instance of the <see cref="Tasks::PrimaveraReadOptions"></see> class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml).
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Aspose::Tasks::PrimaveraReadOptions>& get_PrimaveraReadOptions() const;
    /// <summary>
    /// Sets a specified instance of the <see cref="Tasks::PrimaveraReadOptions"></see> class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_PrimaveraReadOptions(const System::SharedPtr<Aspose::Tasks::PrimaveraReadOptions>& value);
    /// <summary>
    /// Gets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats.
    /// The default encoding is UTF8.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Text::Encoding>& get_Encoding() const;
    /// <summary>
    /// Sets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats.
    /// The default encoding is UTF8.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Encoding(const System::SharedPtr<System::Text::Encoding>& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="LoadOptions"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API LoadOptions();
    
protected:

    /// <summary>
    /// Gets venture license. This value will be set by VentureLicenser if the venture passes us a LoadOptions object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Aspose::LicenseV2::Venture::VentureLicense>& get_VentureLicense() const;
    /// <summary>
    /// Sets venture license. This value will be set by VentureLicenser if the venture passes us a LoadOptions object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_VentureLicense(const System::SharedPtr<Aspose::LicenseV2::Venture::VentureLicense>& value);
    
    ASPOSE_TASKS_SHARED_API LoadOptions(const System::SharedPtr<Aspose::Tasks::PrimaveraReadOptions>& primaveraReadOptions);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(LoadOptions, CODEPORTING_ARGS(const System::SharedPtr<Aspose::Tasks::PrimaveraReadOptions>& primaveraReadOptions));
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ICancellationTracker> GetCancellationTracker();
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:

    ParseErrorCallback pr_ErrorHandler;
    System::String pr_Password;
    System::SharedPtr<Aspose::Tasks::PrimaveraReadOptions> pr_PrimaveraReadOptions;
    System::SharedPtr<System::Text::Encoding> pr_Encoding;
    System::SharedPtr<Aspose::LicenseV2::Venture::VentureLicense> pr_VentureLicense;
    
};

} // namespace Tasks
} // namespace Aspose