PageLegend.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="PageLegend.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 Aspose
{
namespace Tasks
{
namespace Visualization
{
enum class Legend;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Drawing
{
class Image;
} // namespace Drawing
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
namespace Visualization {
 
/// <summary>
/// Represents a page legend which is used for project printing.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS PageLegend : public System::Object
{
    typedef PageLegend ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
public:
 
    /// <summary>
    /// Gets the left aligned text to display in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_LeftText() const;
    /// <summary>
    /// Sets the left aligned text to display in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_LeftText(const System::String& value);
    /// <summary>
    /// Gets the centered text to display in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_CenteredText() const;
    /// <summary>
    /// Sets the centered text to display in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_CenteredText(const System::String& value);
    /// <summary>
    /// Gets the right aligned text to display in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_RightText() const;
    /// <summary>
    /// Sets the right aligned text to display in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RightText(const System::String& value);
    /// <summary>
    /// Gets the pages on which the legend appears. Can be one of the values of the <see cref="Legend"></see> enumeration.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Legend get_LegendOn() const;
    /// <summary>
    /// Sets the pages on which the legend appears. Can be one of the values of the <see cref="Legend"></see> enumeration.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_LegendOn(Legend value);
    /// <summary>
    /// Gets the width of the legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API double get_Width() const;
    /// <summary>
    /// Sets the width of the legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Width(double value);
    /// <summary>
    /// Gets the left aligned image to be displayed in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Drawing::Image>& get_LeftImage() const;
    /// <summary>
    /// Sets the left aligned image to be displayed in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_LeftImage(const System::SharedPtr<System::Drawing::Image>& value);
    /// <summary>
    /// Gets the centered image to be displayed in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Drawing::Image>& get_CenteredImage() const;
    /// <summary>
    /// Sets the centered image to be displayed in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_CenteredImage(const System::SharedPtr<System::Drawing::Image>& value);
    /// <summary>
    /// Gets the right aligned image to be displayed in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Drawing::Image>& get_RightImage() const;
    /// <summary>
    /// Sets the right aligned image to be displayed in the page legend.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RightImage(const System::SharedPtr<System::Drawing::Image>& value);
    
    ASPOSE_TASKS_SHARED_API PageLegend();
    
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_LeftText;
    System::String pr_CenteredText;
    System::String pr_RightText;
    Legend pr_LegendOn;
    double pr_Width;
    System::SharedPtr<System::Drawing::Image> pr_LeftImage;
    System::SharedPtr<System::Drawing::Image> pr_CenteredImage;
    System::SharedPtr<System::Drawing::Image> pr_RightImage;
    
};
 
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose