PageLegend

Inheritance: java.lang.Object, com.aspose.tasks.HeaderFooterInfo

public class PageLegend extends HeaderFooterInfo

Represents a page legend which is used for project printing.

Constructors

ConstructorDescription
PageLegend()

Methods

MethodDescription
getLegendOn()Gets the pages on which the legend appears.
getWidth()Gets the width of the left part (containing project’s name and date by default) of the legend in centimeters.
setLegendOn(int value)Sets the pages on which the legend appears.
setWidth(double value)Sets the width of the left part (containing project’s name and date by default) of the legend in centimeters.

PageLegend()

public PageLegend()

getLegendOn()

public final int getLegendOn()

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

Returns: int - 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: double - the width of the left part (containing project’s name and date by default) of the legend in centimeters.

setLegendOn(int value)

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:

ParameterTypeDescription
valueintthe pages on which the legend appears.

setWidth(double value)

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:

ParameterTypeDescription
valuedoublethe width of the left part (containing project’s name and date by default) of the legend in centimeters.