PageNumberStamp

Inheritance: java.lang.Object, com.aspose.pdf.Stamp com.aspose.pdf.TextStamp com.aspose.pdf.PageNumberStamp, com.aspose.pdf.Stamp, com.aspose.pdf.TextStamp com.aspose.pdf.PageNumberStamp, com.aspose.pdf.TextStamp, com.aspose.pdf.PageNumberStamp

public final class PageNumberStamp extends TextStamp

Represents page number stamp and used to number pages.

Constructors

Constructor	Description
PageNumberStamp	Initializes a new instance of the {@code PageNumberStamp} class. Format is set to “#”.
PageNumberStamp	Initializes a new instance of the {@code PageNumberStamp} class. Format is set to “#”.
PageNumberStamp	Initializes a new instance of the {@code PageNumberStamp} class. Format is set to “#”.

Methods

Method	Description
getFormat	Gets String value for stamping page numbers. Value must include char ‘#’ which is replaced with the page number in the process of stamping.
getNumberingStyle	Numbering style which used by this stamp.
getStartingNumber	Gets value of the number of starting page. Other pages will be numbered starting from this value.
put	Adds page number.
setFormat	Sets String value for stamping page numbers. Value must include char ‘#’ which is replaced with the page number in the process of stamping.
setNumberingStyle	Numbering style which used by this stamp.
setStartingNumber	Sets value of the number of starting page. Other pages will be numbered starting from this value.

PageNumberStamp

public PageNumberStamp()

Initializes a new instance of the {@code PageNumberStamp} class. Format is set to “#”.

PageNumberStamp

Initializes a new instance of the {@code PageNumberStamp} class. Format is set to “#”.

PageNumberStamp

Initializes a new instance of the {@code PageNumberStamp} class. Format is set to “#”.

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: String value

getNumberingStyle

public NumberingStyle getNumberingStyle()

Numbering style which used by this stamp.

Returns: NumberingStyle value @see NumberingStyle

getStartingNumber

public int getStartingNumber()

Gets value of the number of starting page. Other pages will be numbered starting from this value.

Returns: int value

put

Adds page number.

setFormat

Sets String value for stamping page numbers. Value must include char ‘#’ which is replaced with the page number in the process of stamping.

setNumberingStyle

Numbering style which used by this stamp.

setStartingNumber

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 value