OleObject.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="OleObject.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/array.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace IO
{
namespace MSProject
{
class MppOleObjectReader;
class MppOleObjectWriter;
class MppPdfOleObjectWriter;
class MPPReader;
} // namespace MSProject
} // namespace IO
class View;
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents an OLE object which can be inserter into Gantt Chart View of an MPP file.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS OleObject : public System::Object
{
    typedef OleObject ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::MSProject::MppPdfOleObjectWriter;
    friend class Aspose::Tasks::IO::MSProject::MppOleObjectReader;
    friend class Aspose::Tasks::IO::MSProject::MppOleObjectWriter;
    friend class Aspose::Tasks::IO::MSProject::MPPReader;
    
public:
 
    /// <summary>
    /// Gets the name of the instance of the OLE object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Name() const;
    /// <summary>
    /// Sets the name of the instance of the OLE object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Name(const System::String& value);
    /// <summary>
    /// Gets the application name to open the embedded object with.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_ApplicationName() const;
    /// <summary>
    /// Sets the application name to open the embedded object with.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ApplicationName(const System::String& value);
    /// <summary>
    /// Gets the file format of the embedded object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_FileFormat() const;
    /// <summary>
    /// Sets the file format of the embedded object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FileFormat(const System::String& value);
    /// <summary>
    /// Gets the embedded file's data; null if no data was embedded.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::ArrayPtr<uint8_t>& get_Content() const;
    /// <summary>
    /// Sets the embedded file's data; null if no data was embedded.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Content(const System::ArrayPtr<uint8_t>& value);
    /// <summary>
    /// Gets the label of the inserted object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Label() const;
    /// <summary>
    /// Sets the label of the inserted object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Label(const System::String& value);
    /// <summary>
    /// Gets the full path of the inserted object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_FullPath() const;
    /// <summary>
    /// Sets the full path of the inserted object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FullPath(const System::String& value);
    /// <summary>
    /// Gets the path to the temporary file of the inserted object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_TemporaryFile() const;
    /// <summary>
    /// Sets the path to the temporary file of the inserted object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_TemporaryFile(const System::String& value);
    /// <summary>
    /// Gets a flag indicating that OLE object should be shown either as an icon or as its regular picture.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_DisplayAsIcon() const;
    /// <summary>
    /// Sets a flag indicating that OLE object should be shown either as an icon or as its regular picture.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_DisplayAsIcon(bool value);
    /// <summary>
    /// Gets a value indicating whether the project file contains only a link to the actual data stored at the link source.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_Linked();
    /// <summary>
    /// Gets the instance of the <see cref="View"></see> class the inserted object belongs to.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::View> get_View() const;
    /// <summary>
    /// Sets the instance of the <see cref="View"></see> class the inserted object belongs to.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_View(const System::SharedPtr<Aspose::Tasks::View>& value);
    /// <summary>
    /// Gets the object id.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Id() const;
    /// <summary>
    /// Sets the object id.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Id(int32_t value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="OleObject"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API OleObject();
    
protected:
 
    /// <summary>
    /// Gets the link name in the compound file (This link points to the OLE data).
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Link() const;
    /// <summary>
    /// Sets the link name in the compound file (This link points to the OLE data).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Link(const System::String& value);
    /// <summary>
    /// Gets the Id of view the OLE object belongs to.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_ViewId() const;
    /// <summary>
    /// Sets the Id of view the OLE object belongs to.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ViewId(int32_t value);
    
    /// <summary>
    /// Returns directory name in MPP file by OLE object link.
    /// </summary>
    /// <returns>Returns the directory name.</returns>
    ASPOSE_TASKS_SHARED_API System::String GetMppFolderNameByLink();
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::SharedPtr<Aspose::Tasks::View> view;
    System::String pr_Name;
    System::String pr_ApplicationName;
    System::String pr_FileFormat;
    System::ArrayPtr<uint8_t> pr_Content;
    System::String pr_Label;
    System::String pr_FullPath;
    System::String pr_TemporaryFile;
    bool pr_DisplayAsIcon;
    int32_t pr_Id;
    System::String pr_Link;
    int32_t pr_ViewId;
    
};
 
} // namespace Tasks
} // namespace Aspose