PageNumber (Property)

get and change the number of the page displayed in an Image control ("multi-page" image files).
get and change the page number of a PDF file displayed in an Image control of a window.
get and change the page number of a PDF file displayed in the background of a report.

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 23 and later
Remark: To get and change the number of the page displayed in a Word Processing or PDF Reader control, use the NumberDisplayedPage property.

New in version 23
Remark: To get and change the number of the page displayed in a Word Processing or PDF Reader control, use the NumberDisplayedPage property.

Remark: To get and change the number of the page displayed in a Word Processing or PDF Reader control, use the NumberDisplayedPage property.

Versions 25 and later

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

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

New in version 25

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

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

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

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

Example

// Variables
i is int
// Modify the image file associated with the "IMG_MyImage" control in a window
IMG_MyImage = "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

Syntax

Identifying the number of the displayed page Hide the details

<Page number> = <Element used>.PageNumber

<Page number>: Integer

Number of the page currently displayed in the specified Image control or in the background of the specified report.
1 if the format of image file is not "multi-page" or if the first page of "multi-page" file is displayed.
0 if the specified control or report is not associated with a supported image format.

<Element used>: Control or report name

Name of the Image control or report to be used.

Changing the number of the displayed page Hide the details

<Element used>.PageNumber = <Page number>

<Element used>: Control or report name

Name of Image control or report to use.

<Page number>: Integer

Number of the page that will be displayed in the specified Image control or in the background of the specified report.

Remarks

Modifying the page displayed in an Image control

When an image or PDF file is associated with a control (from the window editor, via the Image property, etc.), the image displayed by default corresponds to the first page of the "multi-page" file.

To change the page displayed in the Image control, simply use the PageNumber property.

Caution: The PageNumber property applies only to the image file currently associated with the Image control.

Changing the page of the PDF file displayed in the background of a report

If a PDF file is used as report form, you have the ability to choose (in the report description) the page of the PDF file that will be displayed ("Background" tab, "# of PDF page" option). To programmatically change the page displayed at in the background of the report, simply use the PageNumber property.

Caution: The PageNumber property applies only to the image file currently used as report form.

Number of pages found in a "multi-page" file

To get the number of pages in a "multi-page" image file, use the NumberPage property.

Drawing in an Image control associated with a "multi-page" image

If a drawing (made with drawing functions) is made in the Image control, this drawing will be automatically deleted when the page displayed with the PageNumber property is modified.

This drawing must be re-drawn whenever the page displayed in the image control is modified. To re-draw this drawing, we recommend that you use a procedure.

Limitations

The PageNumber property applies only to:

Image controls in windows.
reports.

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.