PageLegend.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="PageLegend.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include "aspose.tasks.cpp/Visualization/HeaderFooterInfo.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 Aspose {
 
namespace Tasks {
 
namespace Visualization {
 
/// <summary>
/// Represents a page legend which is used for project printing.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS PageLegend : public Aspose::Tasks::Visualization::HeaderFooterInfo
{
    typedef PageLegend ThisType;
    typedef Aspose::Tasks::Visualization::HeaderFooterInfo BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
public:
 
    /// <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 left part (containing project's name and date by default) of the legend in centimeters.
    /// </summary>
    /// <exception cref="ArgumentOutOfRangeException">When attempting to set to a value less than 0.</exception>
    ASPOSE_TASKS_SHARED_API double get_Width() const;
    /// <summary>
    /// Sets the width of the left part (containing project's name and date by default) of the legend in centimeters.
    /// </summary>
    /// <exception cref="ArgumentOutOfRangeException">When attempting to set to a value less than 0.</exception>
    ASPOSE_TASKS_SHARED_API void set_Width(double 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:
 
    double width;
    Legend pr_LegendOn;
    
};
 
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose