Global procedure/function

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage syntax

WLanguage procedures

Procedure parameters

Global procedure/function

Definition

Global procedure

Creating a global procedure

Deleting a global procedure

Test of a global procedure

Public or private global procedure

See also

Global procedure/function

Definition

Two types of procedures are available:

Global procedure: can be used in all the project processes. This global procedure is stored in the project.
Local procedure: can be used in all processes that depend on the object (window, page, report or control) in which this procedure was declared. This local procedure is stored in the object.

Important: You must not declare two procedures with the same name (especially a global procedure and a local procedure).

Reminder:

In WLanguage, there is no distinction between the procedures and the functions. The syntaxes for declaring and using procedures also apply to functions.
You have the ability to create overloaded procedures. For more details, see Prototype overload.

Global procedure

Global procedures and sets of procedures

The global procedures are stored in sets of procedures, associated with the project. Each set of procedures is a ".WDG" file.

Each project contains at least one set of procedures. This set is created by default when creating the project.

The global procedures in a set of procedures can be called from all the events/processes:

of the project,
of the window or page (events of the window / page, of its controls and processes of the associated local procedures),
of the report (events of the report, its controls and processes of the associated local procedures).

Tip: If a procedure is used by a single window or page, this procedure should be described as local to the window or to the page. In this case, the window/page is "independent".

Global server and browser procedures

A project corresponding to a dynamic site contains at least two sets of procedures (a "server" one and a "browser" one).

When creating the project:

the set of server procedures is named "Global procedures of <Project name>" (".WDG" file).
the set of browser procedures is named: "Global procedures of <Project name>_Browser" (".WWN" file).

Remark: A set of global browser procedures is converted into a set of JavaScript procedures. This set of JavaScript procedures is saved in the "<Project name>_WEB" directory and it is named "<Project name>.JS". This set of procedures contains a declaration code and an ending code used to declare the variables global to the set of procedures.

Limit: No global browser procedure can be called by the global server procedures (and conversely).

Creating a global procedure

Creation from the code editor

To create a global procedure from the code editor:

Method 1:
- Open the code editor (press F2 while on an element in the window or page).
- On the "Code" tab, in the "Procedures" group, expand "New" and select "New global procedure" (Shift + F4).
- In the window that appears:
  - Specify the name of the procedure to create.
  - The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
    For more details, see Automatic documentation of procedures.
  - Specify the scope of the procedure. The created procedure is public by default. For more details, see Public or private global procedure.
Method 2:
- Open the code editor (press F2 while on an element in the window or page).
- Select "New .. New empty global procedure" in the context menu.
- In the window that appears:
  - Specify the name of the procedure to create.
  - The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
    For more details, see Automatic documentation of procedures.
  - Specify the scope of the procedure. The created procedure is public by default. For more details, see Public or private global procedure.
Method 3:
- Open the code editor (press F2 while on an element in the window or page).
- Position at the end of the procedure code.
- Type the prototype of procedure to create.
- Validate. The procedure is automatically created.

Remarks:

If the current code is a server code, the global procedure is created in the set of server procedures. If the current code is a browser code, the global procedure is created in the set of browser procedures.
To directly create a server global procedure, go to the "Code" tab, "Procedures" group, expand "New" and select "New global procedure (Server)".
To directly create a browser global procedure, go to the "Code" tab, "Procedures" group, expand "New" and select "New global procedure (Browser)".

To transform a code section already typed in a global procedure into a global procedure:

Select the corresponding code.
Select "New .. Create a global procedure containing the selected code" in the context menu.
Specify:
- the name of the procedure.
- the scope of the procedure. The created procedure is public by default. For more details, see Public or private global procedure.
The procedure is created, the corresponding code is replaced with the call to the procedure with the necessary parameters.

Creation from the "Project explorer" pane

To create a global procedure from the "Project explorer" pane:

Select the "Procedures" folder.
Select the desired set of procedures.
Open the context menu of the set of procedures and select "New global procedure".
In the window that appears:
- Specify the name of the new global procedure.
- The option "Generate a header comment" is used to automatically generate the comment for the procedure prototype.
  For more details, see Automatic documentation of procedures.
- Specify the scope of the procedure. The created procedure is public by default. For more details, see Public or private global procedure.
Validate.

To create a global server or browser procedure, select the corresponding set of procedures.

Displaying the list of global procedures

To display the list of global procedures, press Ctrl + F8 in the code editor.

The global procedures are displayed in the "Project explorer" pane if this pane is displayed.

Remark: To display the list of global browser procedures, press Ctrl + Alt + F8 in the code editor.

Deleting a global procedure

Deletion from the code editor

To delete a global procedure from the code editor:

Click the bar of the procedure in the code editor.
Select "Delete" in the context menu.

Deletion from the "Project explorer" pane

To delete a global procedure from the "Project explorer" pane:

Select the "Procedures" folder.
Select the desired set of procedures.
Open the context menu of the set of procedures and select "Delete".

To delete a server or browser global procedure, select the corresponding set of procedures.

Test of a global procedure

From the code editor

To test a global procedure:

Display the global procedure in the code editor.
Click "GO" in the quick access buttons.
The description window of the procedure test is displayed. This window is used to:
- Enter the different parameters of the procedure.
- Run the procedure test ("Run the procedure test").
- Check the return value.

From the "Project explorer" pane

To test a global procedure:

Select the "Procedures" folder in the "Project explorer" pane.
Select the name of the global procedure whose test must be run.
Select "Run the procedure test" in the context menu.
The description window of the procedure test is displayed. This window is used to:
- Enter the different parameters of the procedure.
- Run the procedure test ("Run the procedure test").
- Check the return value.

Public or private global procedure

A global procedure is public by default: it is accessible from anywhere in the code.

In some cases, it may be useful to restrict the access to a global procedure by making it "Private". In this case, the global procedure cab only be accessed by another global procedure in the set of procedures.

When creating a global procedure, you have the ability to specify whether the procedure is public or private.

To modify the access mode to a global procedure:

Select the global procedure in the "Project explorer" pane.
In the context menu of the procedure, select the new access mode::
- public.
- private.

The color of the procedure bar changes according to its access mode:

red beginning of bar: private procedure.
standard beginning of bar: public procedure.

Remark: External component and private global procedures:
The use of private or public global procedures has an impact in the external components. Indeed, only the procedures explicitly declared as private (with the PRIVATE keyword used in their prototype) found in an external component cannot be directly used by the project that includes this component.