ResourceSavingArgs.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ResourceSavingArgs.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace System
{
namespace IO
{
class Stream;
} // namespace IO
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
///   This class represents set of data that related to external resource file's saving that
///   occurs during conversion to HTML format.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ResourceSavingArgs : public System::Object
{
    typedef ResourceSavingArgs ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
public:
 
    /// <summary>
    ///  Gets the supposed file name that goes from converter to code of custom method.
    ///  Can be use in custom code to decide how to process or where save that file.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_FileName() const;
    /// <summary>
    ///  Sets the supposed file name that goes from converter to code of custom method.
    ///  Can be use in custom code to decide how to process or where save that file.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FileName(const System::String& value);
    /// <summary>
    /// Gets a value indicating whether the stream will be kept open after resource saving finishes.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_KeepStreamOpen() const;
    /// <summary>
    /// Sets a value indicating whether the stream will be kept open after resource saving finishes.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_KeepStreamOpen(bool value);
    /// <summary>
    ///    Gets the binary content of saved file.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::IO::Stream>& get_Stream() const;
    /// <summary>
    ///    Sets the binary content of saved file.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Stream(const System::SharedPtr<System::IO::Stream>& value);
    /// <summary>
    /// Gets the resource URI.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Uri() const;
    /// <summary>
    /// Sets the resource URI.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Uri(const System::String& value);
    
    /// <summary>
    /// Close stream if KeepStreamOpen is false, else flush it.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void CloseStreamIfRequired();
    
    ASPOSE_TASKS_SHARED_API ResourceSavingArgs();
    
protected:
 
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::String pr_FileName;
    bool pr_KeepStreamOpen;
    System::SharedPtr<System::IO::Stream> pr_Stream;
    System::String pr_Uri;
    
};
 
} // namespace Tasks
} // namespace Aspose