Represents a page legend which is used for project printing. More...

#include <PageLegend.h>

Inherits Aspose::Tasks::Visualization::HeaderFooterInfo.

Public Member Functions
Legend	get_LegendOn () const
	Gets the pages on which the legend appears. Can be one of the values of the Legend enumeration. More...

void	set_LegendOn (Legend value)
	Sets the pages on which the legend appears. Can be one of the values of the Legend enumeration. More...

double	get_Width () const
	Gets the width of the left part (containing project's name and date by default) of the legend in centimeters. More...

void	set_Width (double value)
	Sets the width of the left part (containing project's name and date by default) of the legend in centimeters. More...

Public Member Functions inherited from Aspose::Tasks::Visualization::HeaderFooterInfo
System::String	get_LeftText () const
	Gets the left aligned text to display in the parent element. More...

void	set_LeftText (const System::String &value)
	Sets the left aligned text to display in the parent element. More...

System::String	get_CenteredText () const
	Gets the centered text to display in the parent element. More...

void	set_CenteredText (const System::String &value)
	Sets the centered text to display in the parent element. More...

System::String	get_RightText () const
	Gets the right aligned text to display in the parent element. More...

void	set_RightText (const System::String &value)
	Sets the right aligned text to display in the parent element. More...

System::SharedPtr< System::Drawing::Image >	get_LeftImage () const
	Gets the left aligned image to be displayed in the parent element. More...

void	set_LeftImage (const System::SharedPtr< System::Drawing::Image > &value)
	Sets the left aligned image to be displayed in the parent element. More...

System::SharedPtr< System::Drawing::Image >	get_CenteredImage () const
	Gets the centered image to be displayed in the parent element. More...

void	set_CenteredImage (const System::SharedPtr< System::Drawing::Image > &value)
	Sets the centered image to be displayed in the parent element. More...

System::SharedPtr< System::Drawing::Image >	get_RightImage () const
	Gets the right aligned image to be displayed in the parent element. More...

void	set_RightImage (const System::SharedPtr< System::Drawing::Image > &value)
	Sets the right aligned image to be displayed in the parent element. More...

System::Drawing::Size	get_LeftImageSize () const
	Gets the displayed size of the left image. More...

void	set_LeftImageSize (System::Drawing::Size value)
	Sets the displayed size of the left image. More...

System::Drawing::Size	get_CenteredImageSize () const
	Gets the displayed size of the center image. More...

void	set_CenteredImageSize (System::Drawing::Size value)
	Sets the displayed size of the center image. More...

System::Drawing::Size	get_RightImageSize () const
	Gets the displayed size of the right image. More...

void	set_RightImageSize (System::Drawing::Size value)
	Sets the displayed size of the right image. More...

	HeaderFooterInfo ()
	Initializes a new instance of the HeaderFooterInfo class. More...

Detailed Description

Represents a page legend which is used for project printing.

Member Function Documentation

◆ get_LegendOn()

Legend Aspose::Tasks::Visualization::PageLegend::get_LegendOn ( ) const

Gets the pages on which the legend appears. Can be one of the values of the Legend enumeration.

◆ get_Width()

double Aspose::Tasks::Visualization::PageLegend::get_Width ( ) const

Gets the width of the left part (containing project's name and date by default) of the legend in centimeters.

Exceptions

ArgumentOutOfRangeException When attempting to set to a value less than 0.

◆ set_LegendOn()

void Aspose::Tasks::Visualization::PageLegend::set_LegendOn ( Legend value )

Sets the pages on which the legend appears. Can be one of the values of the Legend enumeration.

◆ set_Width()

void Aspose::Tasks::Visualization::PageLegend::set_Width ( double value )

Sets the width of the left part (containing project's name and date by default) of the legend in centimeters.