public class PageLegend extends Object
Represents a page legend which is used for project printing.
Constructor and Description |
---|
PageLegend() |
Modifier and Type | Method and Description |
---|---|
Image |
getCenteredImage()
The centered image to be displayed in the page legend.
|
String |
getCenteredText()
The centered text to display in the page legend.
|
Image |
getLeftImage()
The left aligned image to be displayed in the page legend.
|
String |
getLeftText()
The left aligned text to display in the page legend.
|
int |
getLegendOn()
Specifies the pages on which the legend appears.
|
Image |
getRightImage()
The right aligned image to be displayed in the page legend.
|
String |
getRightText()
The right aligned text to display in the page legend.
|
double |
getWidth()
Specifies a width of the legend.
|
void |
setCenteredImage(Image value)
The centered image to be displayed in the page legend.
|
void |
setCenteredText(String value)
Sets the centered text to display in the page legend.
|
void |
setLeftImage(Image value)
The left aligned image to be displayed in the page legend.
|
void |
setLeftText(String value)
Sets the left aligned text to display in the page legend.
|
void |
setLegendOn(int value)
Specifies the pages on which the legend appears.
|
void |
setRightImage(Image value)
The right aligned image to be displayed in the page legend.
|
void |
setRightText(String value)
Sets the right aligned text to display in the page legend.
|
void |
setWidth(double value)
Specifies a width of the legend.
|
public final Image getCenteredImage()
The centered image to be displayed in the page legend.
public final void setCenteredImage(Image value)
The centered image to be displayed in the page legend.
value
- the centered image to be displayed in the page legend.public final String getCenteredText()
The centered text to display in the page legend.
public final void setCenteredText(String value)
Sets the centered text to display in the page legend.
value
- the centered text to display in the page legend.public final Image getLeftImage()
The left aligned image to be displayed in the page legend.
public final void setLeftImage(Image value)
The left aligned image to be displayed in the page legend.
value
- the left aligned image to be displayed in the page legend.public final String getLeftText()
The left aligned text to display in the page legend.
public final void setLeftText(String value)
Sets the left aligned text to display in the page legend.
value
- the left aligned text to display in the page legend.public final int getLegendOn()
Specifies the pages on which the legend appears. Can be one of the values of the Legend
enum.
public final void setLegendOn(int value)
Specifies the pages on which the legend appears. Can be one of the values of the Legend
enum.
value
- the specified page number on which the legend appears.public final Image getRightImage()
The right aligned image to be displayed in the page legend.
public final void setRightImage(Image value)
The right aligned image to be displayed in the page legend.
value
- the right aligned image to be displayed in the page legend.public final String getRightText()
The right aligned text to display in the page legend.
public final void setRightText(String value)
Sets the right aligned text to display in the page legend.
value
- the specified right aligned text to display in the page legend.public final double getWidth()
Specifies a width of the legend.
public final void setWidth(double value)
Specifies a width of the legend.
value
- the specified width of the legend.Copyright (c) 2008-2019 Aspose Pty Ltd. All Rights Reserved.