PageLegend (Aspose.Tasks for Java 25.9 API Documentation)

java.lang.Object
- com.aspose.tasks.HeaderFooterInfo
- - com.aspose.tasks.PageLegend

```
public class PageLegend
extends HeaderFooterInfo
```
Represents a page legend which is used for project printing.

Constructor Summary

Constructors
Constructor Description

PageLegend()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getLegendOn()`	Gets the pages on which the legend appears.
`double`	`getWidth()`	Gets the width of the left part (containing project's name and date by default) of the legend in centimeters.
`void`	`setLegendOn(int value)`	Sets the pages on which the legend appears.
`void`	`setWidth(double value)`	Sets the width of the left part (containing project's name and date by default) of the legend in centimeters.

Methods inherited from class com.aspose.tasks.HeaderFooterInfo
getCenteredImage, getCenteredImageSize, getCenteredText, getLeftImage, getLeftImageSize, getLeftText, getRightImage, getRightImageSize, getRightText, setCenteredImage, setCenteredImageSize, setCenteredText, setLeftImage, setLeftImageSize, setLeftText, setRightImage, setRightImageSize, setRightText

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PageLegend
```
public PageLegend()
```
- Method Detail
  - getLegendOn
```
public final int getLegendOn()
```
    Gets the pages on which the legend appears. Can be one of the values of the Legend enumeration.
    
    Returns:
    
    the pages on which the legend appears.
  - setLegendOn
```
public final void setLegendOn(int value)
```
    Sets the pages on which the legend appears. Can be one of the values of the Legend enumeration.
    
    Parameters:
    
    value - the pages on which the legend appears.
  - getWidth
```
public final double getWidth()
```
    Gets the width of the left part (containing project's name and date by default) of the legend in centimeters.
    
    Returns:
    
    the width of the left part (containing project's name and date by default) of the legend in centimeters.
    
    Throws:
    
    com.aspose.ms.System.ArgumentOutOfRangeException - When attempting to set to a value less than 0.
  - setWidth
```
public final void setWidth(double value)
```
    Sets the width of the left part (containing project's name and date by default) of the legend in centimeters.
    
    Parameters:
    
    value - the width of the left part (containing project's name and date by default) of the legend in centimeters.
    
    Throws:
    
    com.aspose.ms.System.ArgumentOutOfRangeException - When attempting to set to a value less than 0.