PageNumberStamp
Inheritance: java.lang.Object, com.aspose.pdf.Stamp, com.aspose.pdf.TextStamp
public final class PageNumberStamp extends TextStamp
Represents page number stamp and used to number pages.
Constructors
Constructor | Description |
---|---|
PageNumberStamp(String format) | Initializes a new instance of the PageNumberStamp class. |
PageNumberStamp() | Initializes a new instance of the PageNumberStamp class. |
PageNumberStamp(FormattedText formattedText) | Creates PageNumberStamp by formatted text. |
Methods
Method | Description |
---|---|
getFormat() | Gets String value for stamping page numbers. |
setFormat(String value) | Sets String value for stamping page numbers. |
getStartingNumber() | Gets value of the number of starting page. |
setStartingNumber(int value) | Sets value of the number of starting page. |
put(Page page) | Adds page number. |
getNumberingStyle() | Numbering style which used by this stamp. |
setNumberingStyle(int value) | Numbering style which used by this stamp. |
PageNumberStamp(String format)
public PageNumberStamp(String format)
Initializes a new instance of the PageNumberStamp class.
Parameters:
Parameter | Type | Description |
---|---|---|
format | java.lang.String | String value used for stamping. See Format property for details. |
PageNumberStamp()
public PageNumberStamp()
Initializes a new instance of the PageNumberStamp class. Format is set to “#”.
PageNumberStamp(FormattedText formattedText)
public PageNumberStamp(FormattedText formattedText)
Creates PageNumberStamp by formatted text.
Parameters:
Parameter | Type | Description |
---|---|---|
formattedText | FormattedText | Formatted text which used to create Page Number Stamp. |
getFormat()
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.
Returns: java.lang.String - String value
setFormat(String value)
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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | String value |
getStartingNumber()
public int getStartingNumber()
Gets value of the number of starting page. Other pages will be numbered starting from this value.
Returns: int - int value
setStartingNumber(int value)
public void setStartingNumber(int value)
Sets value of the number of starting page. Other pages will be numbered starting from this value.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int | int value |
put(Page page)
public void put(Page page)
Adds page number.
Parameters:
Parameter | Type | Description |
---|---|---|
page | Page | Page for stamping. |
getNumberingStyle()
public int getNumberingStyle()
Numbering style which used by this stamp.
Returns: int - NumberingStyle value
setNumberingStyle(int value)
public void setNumberingStyle(int value)
Numbering style which used by this stamp.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int | NumberingStyle value |