PageUse (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Functions specific to WEB

Page management functions

Parameters passed to the page to open

Multilingual sites

Principle for opening a page

Events and codes run when PageUse is called

Opening a page of an external component

Miscellaneous

See also

PageUse (Function)

In french: PageUtilise

Displays a WEBDEV page in the browser of the Web user and closes all the current page contexts.

If the function PageUse is used in the Short Code of an Button control, the page will be opened in the destination defined for this Button control ("General" tab of the HEX@ field or function ChangeTarget).

Versions 15 and later

This function is now available for PHP sites.

New in version 15

This function is now available for PHP sites.

This function is now available for PHP sites.

Versions 24 and later

This function is now available in Ajax mode.

New in version 24

This function is now available in Ajax mode.

Example

// Switch the application to English
Nation(nationEnglish)
// Redisplay the PAGE_Login page with captions in English
PageUse(PAGE_Login)

Syntax

PageUse(<Page> [, <Parameter 1> [... [, <Parameter N>]]])

<Page>: Page name

Name of page to display.
If this parameter corresponds to an empty string (""), the page name is the name of the page to which the current event belongs.
In test mode, specify the full path of the page if the page to open is located in a directory other than the project directory.

<Parameter 1>: Type of value sent to the page (optional)

Parameter(s) to pass to the opening event of the page to be opened ("Global declarations" event of the page). These parameters are passed by reference and are considered as global variables to the page.

<Parameter N>: Type of value sent to the page (optional)

Parameter(s) to pass to the opening event of the page to be opened ("Global declarations" event of the page). These parameters are passed by reference and are considered as global variables to the page.

Remarks

Parameters passed to the page to open

The parameters are retrieved in the opening event of the page ("Global declarations" event of the page). Simply write the following line at the beginning of the "global declarations" event:

PROCEDURE <Page name> (<Parameter 1> [, ...[, <Parameter N>]]])

Multilingual sites

PageUse can be used for the multilingual sites. Indeed, this function is used to re-open a page while taking into account the language specified by Nation.

Principle for opening a page

The following operations are performed by PageUse:

close all the opened context on the server
create a page context on the server
returning the page to the browser of web user.

Events and codes run when PageUse is called

The different events and codes executed when the page is displayed are as follows:

Page opening code ( "Global declarations" event of the page).
"Initializing" event of the page controls.
Display page in the browser.
Javascript code associated with the page and the controls.
WLanguage code following the call to PageUse (if it exists).

Opening a page of an external component

To open a page of an external component, use the name of the page of the external component (the component being included in the project). For example:

PageUse(ComponentPage)

If a conflict occurs with a project element, the name of the element must be prefixed by the name of the external component. For example:

PageUse(MyComponent.Page)

To use the name of the page in a variable, the name of the external component must be specified. For example:

sPage is string = "MyComponent.MyPage"

PageUse(sPage)

Miscellaneous

To re-display a page, we recommend that you use PageRefresh.
To display a page without closing the contexts opened on the server, we recommend that you use PageDisplay.
You should not use WLanguage code after a call to PageUse.
Versions 20 and later
If your project uses pre-launched sessions, this function must not be used in the "Initializing" event of the project. This function must be used in the event "Initializing the project after connection to the site".
New in version 20
If your project uses pre-launched sessions, this function must not be used in the "Initializing" event of the project. This function must be used in the event "Initializing the project after connection to the site".
If your project uses pre-launched sessions, this function must not be used in the "Initializing" event of the project. This function must be used in the event "Initializing the project after connection to the site".

Component : wd260page.dll