public final class PageNumber extends Object
Represents a page number format that includes an index, total number of pages, and a delimiter.
Modifier and Type | Class and Description |
---|---|
static class |
PageNumber.PageIndex
Represents the page index component in the page number format.
|
static class |
PageNumber.PageTotalNum
Represents the total number of pages component in the page number format.
|
Constructor and Description |
---|
PageNumber() |
Modifier and Type | Method and Description |
---|---|
String |
getDelimiter()
Gets or sets the delimiter used in the page number format.
|
PageNumber.PageIndex |
getIndex()
Gets or sets the page index component of the page number format.
|
int |
getOffset()
Gets or sets the offset to be added to the page index.
|
String |
getPageNumberString(int pageNumber,
int count)
Returns a formatted string representing the page number based on the current settings.
|
PageNumber.PageTotalNum |
getTotalNum()
Gets or sets the total number of pages component of the page number format.
|
void |
setDelimiter(String value)
Gets or sets the delimiter used in the page number format.
|
void |
setIndex(PageNumber.PageIndex value)
Gets or sets the page index component of the page number format.
|
void |
setOffset(int value)
Gets or sets the offset to be added to the page index.
|
void |
setTotalNum(PageNumber.PageTotalNum value)
Gets or sets the total number of pages component of the page number format.
|
public final int getOffset()
Gets or sets the offset to be added to the page index.
public final void setOffset(int value)
Gets or sets the offset to be added to the page index.
value
- int valuepublic final PageNumber.PageIndex getIndex()
Gets or sets the page index component of the page number format. The formatted string will include a placeholder for the page index.
public final void setIndex(PageNumber.PageIndex value)
Gets or sets the page index component of the page number format. The formatted string will include a placeholder for the page index.
value
- PageIndex instancepublic final PageNumber.PageTotalNum getTotalNum()
Gets or sets the total number of pages component of the page number format. The formatted string will include a placeholder for the total number of pages.
public final void setTotalNum(PageNumber.PageTotalNum value)
Gets or sets the total number of pages component of the page number format. The formatted string will include a placeholder for the total number of pages.
value
- PageTotalNum instancepublic final String getDelimiter()
Gets or sets the delimiter used in the page number format. The formatted string will be updated based on the specified delimiter.
public final void setDelimiter(String value)
Gets or sets the delimiter used in the page number format. The formatted string will be updated based on the specified delimiter.
value
- String valuepublic final String getPageNumberString(int pageNumber, int count)
Returns a formatted string representing the page number based on the current settings.
pageNumber
- The current page number.count
- The total number of pages.Copyright © 2025 Aspose. All Rights Reserved.