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 Image and PDF Reader controls that display a PDF file in Android applications.

This property is now available for Image and PDF Reader controls that display a PDF file in iPhone/iPad applications.

New in version 25

This property is now available for Image and PDF Reader controls that display a PDF file in Android applications.

This property is now available for Image and PDF Reader controls that display a PDF file in iPhone/iPad applications.

This property is now available for Image and PDF Reader controls that display a PDF file in Android applications.

This property is now available for Image and PDF Reader controls that display a PDF file in iPhone/iPad 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
// Timeout 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 used>.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 used>: Control name

Name of the control to be used:
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 large number of pages

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

In this case:

NumberPage is a blocking property: it waits for the file load operation to complete. The application is blocked.
The NumberAccessiblePages property returns the number of pages currently loaded in the PDF file without waiting for the load process to complete.
The NumberDisplayedPage property returns the number of the page currently displayed in the control (at least 50% of the page).

New in version 23

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

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

In this case:

NumberPage is a blocking property: it waits for the file load operation to complete. The application is blocked.
The NumberAccessiblePages property returns the number of pages currently loaded in the PDF file without waiting for the load process to complete.
The NumberDisplayedPage property returns the number of the page currently displayed in the control (at least 50% of the page).

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

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

In this case:

NumberPage is a blocking property: it waits for the file load operation to complete. The application is blocked.
The NumberAccessiblePages property returns the number of pages currently loaded in the PDF file without waiting for the load process to complete.
The NumberDisplayedPage property returns the number of the page currently displayed in the control (at least 50% of the page).

Limit

The NumberPage property applies only to:

Image controls in windows,
Chart controls in windows,
Versions 23 and later
PDF Reader controls.
New in version 23
PDF Reader controls.
PDF Reader controls.
Versions 23 and later
Word Processing controls.
New in version 23
Word Processing controls.
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.