PageUse (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Web-specific functions / Page 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

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

PageUse (Function)

In french: PageUtilise

Displays a WEBDEV page in the user's browser and closes all page contexts currently open on the server.

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 in multilingual sites. This function is used to reopen a page while taking into account the language specified by Nation.

Principle for opening a page

PageUse does the following:

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

Remark: If PageUse is used in the code of a Button control, the page will be opened in the target defined for this Button control ("General" tab of the control description or ChangeTarget).

Events and codes run when PageUse is called

The following events are run when the page is displayed:

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 after the call to PageUse (if used).

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 redisplay a page, it is recommended to 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.
If your project uses pre-launched sessions, this function must not be used in the project initialization event. This function must be used in the "Initialization in pre-launched session mode" event.

Component: wd300page.dll