ExecuteProcess (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Functions for Windows management

Various WINDEV functions

ExecuteProcess

Presentation

Example

Running the Expand/Collapse process

Calling a global component procedure

See also

ExecuteProcess (Function)

In french: ExécuteTraitement

Starts the execution of a process by programming (which means without any particular action performed by the user). The process run can be:

a process of a control (found in a window, page or report),
a process of a menu option,
a process of a report block,
a process of a window,
a process of a page,
a process of a report,
a process of a procedure.
Versions 17 and later
Note: To trigger the execution of a procedure by the main application thread, use ExecuteMainThread.
New in version 17
Note: To trigger the execution of a procedure by the main application thread, use ExecuteMainThread.
Note: To trigger the execution of a procedure by the main application thread, use ExecuteMainThread.

The process run can only be a process belonging to a page control, a page or a procedure. Called in server code, only the server process of the element is run. Called in browser code, the browser code and server code of the element are run.

The process run can be a process belonging to a window control, a menu option, a window or a procedure.

Versions 16 and later

In Windows Phone, the process run can be a process belonging to a window control, a window or a procedure.

New in version 16

In Windows Phone, the process run can be a process belonging to a window control, a window or a procedure.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 16 and later

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Windows Phone applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

Example

// Runs the click code on a button
ExecuteProcess(BTN_Save, trtClick)

// Runs a local procedure (test) that belongs
// to another opened window/page (menu)
ExecuteProcess(Menu.Test, trtProcedure)

// Runs the ReadFile procedure
// and passes the file name in parameter
ExecuteProcess(ReadFile, trtProcedure, FileName)

Syntax

Running the process of a control Hide the details

ExecuteProcess(<Control name> , <Process>)

<Control name>: Character string (with or without quotes)

Name of control (or menu option) associated with the process to run. For an option in a popup menu, use the following notation: <Name of popup menu>.<Option name>.

<Process>: Integer constant

Window control: Process to run among the available processes of controls (not the ones available with the event bar).
Versions 22 and later
trtAction
New in version 22
trtAction
trtAction Action code of Web Component control. This code is available in server code and in browser code.
This constant is not available.
Versions 22 and later
trtValueAssignment
New in version 22
trtValueAssignment
trtValueAssignment Code for assigning the Value property of Web Component control. This code is available in browser code only.
This constant is not available.
trtLineDisplay Code used to display a row (Table control only).
This constant is not available.
Versions 24 and later
trtAddToken
New in version 24
trtAddToken
trtAddToken Code for adding a token into a "Text token" edit control.
This constant is not available.
Versions 20 and later
trtAddWidget
New in version 20
trtAddWidget
trtAddWidget Code for adding a widget to a Dashboard control.
This constant is not available.
This constant is not available.
Versions 23 and later
trtAfterOpeningDocument
New in version 23
trtAfterOpeningDocument
trtAfterOpeningDocument "After opening document" code of Word Processing control, Image Editor control, Spreadsheet control or PDF Reader control.
This constant is not available.
Versions 15 and later
trtBeforeCreatingOrganizerApt
New in version 15
trtBeforeCreatingOrganizerApt
trtBeforeCreatingOrganizerApt "Before creating the appointment" code of Organizer control.
This constant is not available.
This constant is not available.
This constant is not available.
Versions 16 and later
trtBeforeCreatingScheduleApt
New in version 16
trtBeforeCreatingScheduleApt
trtBeforeCreatingScheduleApt "Before creating the appointment" code of Scheduler control.
This constant is not available.
This constant is not available.
Versions 23 and later
trtBeforeClosingDocument
New in version 23
trtBeforeClosingDocument
trtBeforeClosingDocument "Before closing document" code of Word Processing control, Image Editor control, Spreadsheet control or PDF Reader control.
This constant is not available.
Versions 15 and later
trtChangeOrganizerPeriod
New in version 15
trtChangeOrganizerPeriod
trtChangeOrganizerPeriod "Whenever changing period" code of Organizer control.
This constant is not available.
Versions 16 and later
trtChangeSchedulePeriod
New in version 16
trtChangeSchedulePeriod
trtChangeSchedulePeriod "Whenever changing period" code of Scheduler control.
This constant is not available.
Versions 22 and later
trtChangePlane
New in version 22
trtChangePlane
trtChangePlane "Whenever changing plane" code of a Sliding Banner control.
This constant is not available.
Versions 20 and later
trtChangePositionMap
New in version 20
trtChangePositionMap
trtChangePositionMap "Whenever changing position" code of Map control.
This constant is not available.
Versions 20 and later
trtResizeWidget
New in version 20
trtResizeWidget
trtResizeWidget "Resizing a Widget" code of Dashboard control.
This constant is not available.
Versions 22 and later
trtDelayedPlaneLoad
New in version 22
trtDelayedPlaneLoad
trtDelayedPlaneLoad "Delayed plane load" code of a plane.
This constant is not available.
trtClick Click code of control.
trtRightClick Right-click code (for the TreeView control only).
This constant is not available.
Versions 22 and later
trtClickButtonArrow
New in version 22
trtClickButtonArrow
trtClickButtonArrow Click code on the arrow associated with a button.
This constant is not available.
Versions 24 and later
trtClickToken
New in version 24
trtClickToken
trtClickToken Click code on a token in a "Text token" edit control.
This constant is not available.
Versions 15 and later
trtMoveOrganizerApt
New in version 15
trtMoveOrganizerApt
trtMoveOrganizerApt Code for moving an appointment in an Organizer control.
This constant is not available.
This constant is not available.
Versions 16 and later
trtMoveScheduleApt
New in version 16
trtMoveScheduleApt
trtMoveScheduleApt Code for moving an appointment in a Scheduler control.
This constant is not available.
This constant is not available.
Versions 20 and later
trtMoveWidget
New in version 20
trtMoveWidget
trtMoveWidget "Moving a Widget" code of Dashboard control.
This constant is not available.
This constant is not available.
trtDoubleClick Double-click code.
This constant is not available.
trtCollapseExpandBranch Collapsed/Expanded code of a node in a TreeView or TreeView Table control.
Caution: This parameter requires a specific syntax. See remarks for more details.
This constant is not available.
Versions 22 and later
trtCollapseExpandBreak
New in version 22
trtCollapseExpandBreak
trtCollapseExpandBreak Collapsed/Expanded code of a break in a Looper or Table control.
This constant is not available.
trtEnter Entry code in the control.
trtLineEnter Entry code of a row (Table control only).
This constant is not available.
This constant is not available.
Versions 15 and later
trtEnterInputOrganizerApt
New in version 15
trtEnterInputOrganizerApt
trtEnterInputOrganizerApt Entry code in input for an appointment in an Organizer control.
This constant is not available.
Versions 16 and later
trtEnterInputSchedulerApt
New in version 16
trtEnterInputSchedulerApt
trtEnterInputSchedulerApt Entry code in input for an appointment in a Scheduler control.
This constant is not available.
trtComboClosing Closing code of drop-down list.
This constant is not available.
This constant is not available.
trtEndInitialization "End of initialization" code (browsing List Box, Table and Combo Box control).
This constant is not available.
trtEndChange "End of modification" code (Slider and Scrollbar control only).
This constant is not available.
trtInit Initialization code of control.
This constant is not available.
trtReadLast Code for reading the last record (Table control only)
This constant is not available.
trtReadPrevious Code for reading the previous record (Table control only).
This constant is not available.
trtReadFirst Code for reading the first record (Table control only).
This constant is not available.
trtReadNext Code for reading the next record (Table control only).
This constant is not available.
trtChange "Whenever modified" code of control.
This constant is not available.
Versions 22 and later
trtModificationSpreadsheetCell
New in version 22
trtModificationSpreadsheetCell
trtModificationSpreadsheetCell "Cell modification" code of Spreadsheet control.
This constant is not available.
Versions 24 and later
trtModificationColumnFilter
New in version 24
trtModificationColumnFilter
trtModificationColumnFilter Code "Whenever modifying the filter (user input in header)" of a Table Column control.
This constant is not available.
trtSliderChange "Whenever modified" code (Slider control only).
This constant is not available.
Versions 15 and later
trtZoomModification
New in version 15
trtZoomModification
trtZoomModification Code for modifying the zoom of a Range Slider control.
This constant is not available.
trtMenuOption Code of menu option (main or popup menu).
This constant is not available.
This constant is not available.
trtComboOpening Code for opening the drop-down list of Combo Box control.
This constant is not available.
This constant is not available.
Versions 23 and later
trtRefreshRibbon
New in version 23
trtRefreshRibbon
trtRefreshRibbon Code for refreshing the ribbon of PDF Reader and Word Processing controls.
This constant is not available.
Versions 16 and later
trtReassignResourceScheduleApt
New in version 16
trtReassignResourceScheduleApt
trtReassignResourceScheduleApt Code for re-assigning an appointment in a Scheduler control.
This constant is not available.
This constant is not available.
Versions 22 and later
trtValueRetrieval
New in version 22
trtValueRetrieval
trtValueRetrieval Code for retrieving the Value property of a Web Component control. This code is available in browser code only.
This constant is not available.
Versions 15 and later
trtResizeOrganizerApt
New in version 15
trtResizeOrganizerApt
trtResizeOrganizerApt Code for resizing an appointment in an Organizer control.
This constant is not available.
Versions 16 and later
trtResizeScheduleApt
New in version 16
trtResizeScheduleApt
trtResizeScheduleApt Code for resizing an appointment in a Scheduler control.
This constant is not available.
trtSelection Selection code (Combo Box, List Box and Table control).
This constant is not available.
Versions 15 and later
trtSelectOrganizerPeriod
New in version 15
trtSelectOrganizerPeriod
trtSelectOrganizerPeriod Code for selecting a period in an Organizer control.
This constant is not available.
Versions 16 and later
trtSelectSchedulePeriod
New in version 16
trtSelectSchedulePeriod
trtSelectSchedulePeriod Code for selecting a period in a Scheduler control.
This constant is not available.
Versions 15 and later
trtSelectOrganizerApt
New in version 15
trtSelectOrganizerApt
trtSelectOrganizerApt Code for selecting an appointment in an Organizer control.
This constant is not available.
Versions 16 and later
trtSelectScheduleApt
New in version 16
trtSelectScheduleApt
trtSelectScheduleApt Code for selecting an appointment in a Scheduler control.
This constant is not available.
This constant is not available.
trtExit Exit code of control.
trtLineExit Exit code of row (Table control only).
This constant is not available.
Versions 15 and later
trtOrganizerInputExitApt
New in version 15
trtOrganizerInputExitApt
trtOrganizerInputExitApt Exit code from input for an appoingment in an Organizer control.
This constant is not available.
Versions 16 and later
trtScheduleInputExitApt
New in version 16
trtScheduleInputExitApt
trtScheduleInputExitApt Exit code from input for an appoingment in a Scheduler control.
This constant is not available.
trtSpinPlus Increment code of Spin control.
This constant is not available.
trtSpinMinus Decrement code of Spin control.
This constant is not available.
Versions 24 and later
trtDeleteToken
New in version 24
trtDeleteToken
trtDeleteToken Code for deleting a token from a "Text token" edit control.
This constant is not available.
Versions 15 and later
trtDeleteOrganizerApt
New in version 15
trtDeleteOrganizerApt
trtDeleteOrganizerApt Code for deleting an appointment from an Organizer control.
This constant is not available.
Versions 16 and later
trtDeleteScheduleApt
New in version 16
trtDeleteScheduleApt
trtDeleteScheduleApt Code for deleting an appointment from a Scheduler control.
This constant is not available.
Versions 20 and later
trtDeleteWidget
New in version 20
trtDeleteWidget
trtDeleteWidget Code for deleting a widget from a Dashboard control.
This constant is not available.
This constant is not available.
Versions 20 and later
trtPullToRefresh
New in version 20
trtPullToRefresh
trtPullToRefresh "Pull to refresh" code of a Table or Looper control.
This constant is not available.

Control or block of a report: Process to run among the available processes:
trtPrePrint "Pre Print" code of control or block.
This constant is not available.
trtPostPrint "Post Print" code of a block.
This constant is not available.

Running the process of a window Hide the details

ExecuteProcess(<Window> , <Process>)

<Window>: Character string (with or without quotes)

Name of window whose process must be run.

<Process>: Integer constant

Process to run among the processes available for the windows.
trtOpening or trtInit Initialization code of window.
trtClosing Closing code of window.
trtGetFocus Code of focus gain for the window.
This constant is not available.
trtKillFocus Code of focus loss for the window.
This constant is not available.
trtResize Code for resizing the window.
This constant is not available.
trtClick Code of the button associated with the click in the window.
trtRightClick Code of button associated with the right click in the window.
This constant is not available.
trtDoubleClick Code of button associated with the double click in the window.
This constant is not available.
trtChange Modification code of window.
trtSystemButton "Before closing with OK/Close button" code.
This constant is available for Windows Mobile and Android only.
Versions 20 and later
trtRequestUpdate
New in version 20
trtRequestUpdate
trtRequestUpdate
Versions 22 and later
trtUpdateUI
New in version 22
trtUpdateUI
trtUpdateUI "Request for updating the display" code.
Versions 23 and later
trtChangeLayout
New in version 23
trtChangeLayout
trtChangeLayout "Change of layout" code.
This constant is not available.

Running the process of a page Hide the details

ExecuteProcess(<Page> , <Process>)

<Page>: Character string (with or without quotes)

Name of page whose process must be run.
The name of the page must be enclosed in quotes.

<Process>: Integer constant

Process to run among the processes available for the pages.
trtOpening
Opening code of page.
trtClosing
Closing code of page.
This constant has no effect.
trtInit
Initialization code of page.
Versions 22 and later
trtChangeBlade
New in version 22
trtChangeBlade
trtChangeBlade
"Whenever changing blade" code (page in Responsive Web Design mode).
trtLoad
Load code of the page.
trtUnload
Code for unloading the page.
Versions 22 and later
trtScroll
New in version 22
trtScroll
trtScroll
"Scroll" code of page.
trtReset
Code for page reset (initialized form).
trtSubmit
Code for page submit (form sent).

Running the process of a report Hide the details

ExecuteProcess(<Report name> , <Process>)

<Report name>: Character string (with or without quotes)

Name of the report whose process must be run.

<Process>: Integer constant

Process to run among the processes available for the reports.
trtOpening or trtInit Opening code of report.
trtClosing Closing code of report.
trtReadData Code for reading the report data.
This constant is not available.
trtFilter Code for filtering the report data.
This constant is not available.

Running a procedure Hide the details

<Result> = ExecuteProcess(<Procedure name> , <Process> [, <Parameter 1> [... [, <Parameter N>]]])

<Result>: Any

Return value of procedure called. This value is identical to the value obtained if the procedure is run directly.

<Procedure name>: Character string

Name of procedure to run.
The procedure to run corresponds to a server procedure.

<Process>: Integer constant

Procedure to run. This procedure corresponds to:
one of the following constants:
trtProcedure Run the specified procedure according to the runtime context (procedure of the window, procedure of the WINDEV/WEBDEV component or procedure of the project).
trtProjectProcedure Runs the specified procedure. This procedure is a procedure of the project that is hosting the WINDEV/WEBDEV component.
This parameter can only be used for a WINDEV/WEBDEV component included in another project.
Versions 16 and later
a Procedure description variable (can only be used to run a class method). See Enumerating and handling the objects of a class for more details.
New in version 16
a Procedure description variable (can only be used to run a class method). See Enumerating and handling the objects of a class for more details.
a Procedure description variable (can only be used to run a class method). See Enumerating and handling the objects of a class for more details.

<Parameter 1>: Any optional type

First optional parameter that will be passed to the procedure.

<Parameter N>: Any optional type

Nth optional parameter that will be passed to the procedure.

Remarks

Running the Expand/Collapse process

For a TreeView control
The "Collapse/Expand" process of a treeview available in the code editor expects the two following parameters:

<Element path>: Text variable containing the full path of the element currently collapsed or expanded. All you have to do is specify the name of a variable, this variable will be automatically initialized at run time.
<Collapsed>: Boolean variable, used to find out the action performed by the user (collapse = True, expand = False). All you have to do is specify the name of a variable, this variable will be automatically initialized at run time.

These two parameters must be specified when this process is run by ExecuteProcess. In this case, the following syntax must be used:

ExecuteProcess(<Name of TreeView Control>, trtCollapseExpandBranch, ...
<Element path>, <Collapsed>)

See WLanguage processes associated with a TreeView control for more details.

For a TreeView Table control
The "Collapse/Expand" process of a treeview table in the code editor expects no parameter.

When this process is run by ExecuteProcess, the following syntax must be used:

ExecuteProcess(<Name of TreeView Table Control>, trtCollapseExpandBranch)

Calling a global component procedure

ExecuteProcess is used to call a global component procedure. To do so, use the following syntax:

ExecuteProcess(<Component>.<Set of procedures>.<Procedure>, ...
trtProcedure)

Example:

ExecuteProcess("MyComponent.Set_WDExample.MyProcedure", trtProcedure)

In a thread started by a component, ExecuteProcess cannot be used to call a local procedure of a window of the host project.

You must use a global procedure of the host project to call the local procedure of the window.

Business / GUI classification : Neutral code

Component : wd250vm.dll