pageNumber Property

Summary

The current number of this page in the document.

Syntax

JavaScript Syntax

Object.defineProperty(DocumentPage.prototype, 'pageNumber', 
	get: function() 
)

TypeScript Syntax

pageNumber: number; // read-only

Property Value

The 1-based number of this DocumentPage in the document.

Remarks

This value is the index of this page in DocumentPages plus 1. It corresponds to the current page number in the document.

OriginalPageNumber is the number of this DocumentPage in the original document file. When the document is loaded, OriginalPageNumber and PageNumber will contain the same value. If the user modifies the pages of the document by adding, removing or replacing pages, then the two values will differ. OriginalPageNumber will never change and will still holds the value in the original document while PageNumber will return the current updated number of the page in the document.

When a page is added to the document by the user, the value of OriginalPageNumber will be -1 since it does not correspond to an item in the original document.

If this page was added to a virtual document, then PageNumber will not change. It will always contains the original value that corresponds to its location in its original document. To find out the number of page in virtual document, use the IndexOf method of the DocumentPages object of the target document passing the DocumentPage (remembering that this method will return the 0-based index, therefore add 1 in order to get the page number). Refer to Creating Documents with LEADTOOLS Documents Library for more information.

Refer to Loading Using LEADTOOLS Documents Library for more information.

Example

For an example, refer to LoadFromUri.

Requirements

Target Platforms