NumberPage (Property)

the number of pages found in a "multi-page" image file. This image is displayed in an Image control or in the background of a Chart control.
the number of pages found in a PDF file displayed in an Image control.
Versions 23 and later
the number of pages found in a PDF file displayed in a PDF Reader control.
New in version 23
the number of pages found in a PDF file displayed in a PDF Reader control.
the number of pages found in a PDF file displayed in a PDF Reader control.
Versions 23 and later
the number of pages found in a DOCX file displayed in a Word Processing control.
New in version 23
the number of pages found in a DOCX file displayed in a Word Processing control.
the number of pages found in a DOCX file displayed in a Word Processing control.

Reminder: Some image formats (TIFF for example) can contain several images in the same file. Each image corresponds to a file page. These formats are called "multi-page" formats.

Versions 25 and later

This property is now available for PDF Reader controls in Android applications.

New in version 25

This property is now available for PDF Reader controls in Android applications.

Example

// Modify the image file associated with the "IMG_MyImage" control
IMG_MyImage..Image = "MultipageFile.TIF"
// Successively display the different pages found in the image file
FOR i = 1 TO IMG_MyImage..NumberPage
IMG_MyImage..PageNumber = i
// Time-out for loading images
Multitask(-100)
END

// Display page 23 in the PDF Reader control
IF PDF_MyPDFReader..NumberPage>23 THEN
PDF_MyPDFReader..NumberDisplayedPage = 23
END

Syntax

<Number of Pages> = <Control name>..NumberPage

<Number of Pages>: Integer

Number of pages found in the file associated with the specified control.
1 if the format of image file is not "multi-page" or if the "multi-page" format contains a single page.
0 if the specified control is not associated with an image format supported by WINDEV.

<Control name>: Character string (with or without quotes)

Name of control to use:
Name of Image control,
Name of Chart control,
Versions 23 and later
Name of PDF Reader control.
New in version 23
Name of PDF Reader control.
Name of PDF Reader control.
Versions 23 and later
Name of Word Processing control.
New in version 23
Name of Word Processing control.
Name of Word Processing control.

Remarks

Modifying the displayed page

To modify the displayed page:

For the Image controls and the Chart controls, use ..PageNumber.
Versions 23 and later
For the PDF Reader controls and the Word Processing controls, use ..NumberDisplayedPage.
New in version 23
For the PDF Reader controls and the Word Processing controls, use ..NumberDisplayedPage.
For the PDF Reader controls and the Word Processing controls, use ..NumberDisplayedPage.

Versions 23 and later

Case of PDF and DOCX files with a huge number of pages

If the PDF or DOCX file opened in the control contains a huge number of pages, the control loads each page successively: some pages are not immediately accessible.

In this case:

..NumberPage is a locking property: it waits for the end of file load. The application is locked.
..NumberAccessiblePages returns the number of PDF pages currently loaded without having to wait for the end of load.
..NumberDisplayedPage returns the number of the page currently displayed in the control (more than 50% of the page is displayed in the control).

New in version 23

Case of PDF and DOCX files with a huge number of pages

If the PDF or DOCX file opened in the control contains a huge number of pages, the control loads each page successively: some pages are not immediately accessible.

In this case:

..NumberPage is a locking property: it waits for the end of file load. The application is locked.
..NumberAccessiblePages returns the number of PDF pages currently loaded without having to wait for the end of load.
..NumberDisplayedPage returns the number of the page currently displayed in the control (more than 50% of the page is displayed in the control).

Case of PDF and DOCX files with a huge number of pages

If the PDF or DOCX file opened in the control contains a huge number of pages, the control loads each page successively: some pages are not immediately accessible.

In this case:

..NumberPage is a locking property: it waits for the end of file load. The application is locked.
..NumberAccessiblePages returns the number of PDF pages currently loaded without having to wait for the end of load.
..NumberDisplayedPage returns the number of the page currently displayed in the control (more than 50% of the page is displayed in the control).

Limit

..NumberPage only applies to:

the Image controls and the Chart controls found in the windows,
Versions 23 and later
the PDF Reader controls.
New in version 23
the PDF Reader controls.
the PDF Reader controls.
Versions 23 and later
the Word Processing controls.
New in version 23
the Word Processing controls.
the Word Processing controls.

Related Examples:

Unit examples (WINDEV): The Image control (display a PDF or a TIFF)

[ + ] Displaying a PDF or TIFF document in the Image control found in a window.