public final class PageNumberStamp extends TextStamp
Represents page number stamp and used to number pages.
DefaultFontSize| Constructor and Description |
|---|
PageNumberStamp()
Initializes a new instance of the
PageNumberStamp class. |
PageNumberStamp(FormattedText formattedText)
Creates PageNumberStamp by formatted text.
|
PageNumberStamp(String format)
Initializes a new instance of the
PageNumberStamp class. |
| Modifier and Type | Method and Description |
|---|---|
String |
getFormat()
Gets String value for stamping page numbers.
|
int |
getNumberingStyle()
Numbering style which used by this stamp.
|
int |
getStartingNumber()
Gets value of the number of starting page.
|
void |
put(Page page)
Adds page number.
|
void |
setFormat(String value)
Sets String value for stamping page numbers.
|
void |
setNumberingStyle(int value)
Numbering style which used by this stamp.
|
void |
setStartingNumber(int value)
Sets value of the number of starting page.
|
getDefaultFont, getDraw, getHeight, getMaxRowWidth, getTextAlignment, getTextState, getTreatYIndentAsBaseLine, getValue, getWidth, isJustify, isScale, isWordWrap, setDraw, setHeight, setJustify, setMaxRowWidth, setScale, setTextAlignment, setTreatYIndentAsBaseLine, setValue, setWidth, setWordWrapgetBackground, getBottomMargin, getHorizontalAlignment, getLeftMargin, getOpacity, getOutlineOpacity, getOutlineWidth, getRightMargin, getRotate, getRotateAngle, getStampId, getTopMargin, getVerticalAlignment, getXIndent, getYIndent, getZoom, getZoomX, getZoomY, setBackground, setBottomMargin, setHorizontalAlignment, setLeftMargin, setOpacity, setOutlineOpacity, setOutlineWidth, setRightMargin, setRotate, setRotateAngle, setStampId, setTopMargin, setVerticalAlignment, setXIndent, setYIndent, setZoom, setZoomX, setZoomYpublic PageNumberStamp(String format)
Initializes a new instance of the PageNumberStamp class.
format - String value used for stamping. See Format property for details.public PageNumberStamp()
Initializes a new instance of the PageNumberStamp class. Format is set to "#".
public PageNumberStamp(FormattedText formattedText)
Creates PageNumberStamp by formatted text.
formattedText - Formatted text which used to create Page Number Stamp.public String getFormat()
Gets String value for stamping page numbers. Value must include char '#' which is replaced with the page number in the process of stamping.
public void setFormat(String value)
Sets String value for stamping page numbers. Value must include char '#' which is replaced with the page number in the process of stamping.
value - String valuepublic int getStartingNumber()
Gets value of the number of starting page. Other pages will be numbered starting from this value.
public void setStartingNumber(int value)
Sets value of the number of starting page. Other pages will be numbered starting from this value.
value - int valuepublic void put(Page page)
Adds page number.
public int getNumberingStyle()
Numbering style which used by this stamp.
NumberingStylepublic void setNumberingStyle(int value)
Numbering style which used by this stamp.
value - NumberingStyle valueNumberingStyle