ExecuteProcess (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Windows management functions

Miscellaneous WINDEV functions

ExecuteProcess

Presentation

Example

Executing the "Collapse/Expand" event

Calling a global component procedure

See also

ExecuteProcess (Function)

In french: ExécuteTraitement

Starts the execution of an event or process programmatically, i.e. without the user having to perform any particular action in the interface. The event/process executed can be:

an event of a control (in a window, a page or a report),
an event of a menu option,
an event of a report block,
an event of a window,
an event of a page,
an event of a report,
a process of a procedure.
Remark: To execute of a procedure in the main thread of the application, use:
- the ExecuteMainThread function.
- New in version 28
  the ExecuteMainThreadAsynchronous function.

The event/process executed can only be from a control in a page, from a page or from a procedure. When called in server code, only the server code of the element is executed. When called in browser code, both the browser and server codes of the element are executed.

The event/process executed can only be from a control in a window, from a menu option, from a window or a procedure.

Example

// Execute the click process of a Button control
ExecuteProcess(BTN_Save, trtClick)

// Execute the click process of a control via indirection
ExecuteProcess({NControl}..Value, trtClick)

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

// Runs the ReadFile procedure
// and passes the file name as parameter
ExecuteProcess(ReadFile, trtProcédure, FileName)

Syntax

Executing an event associated with a control Hide the details

ExecuteProcess(<Control used> , <Process> [, <Parameter 1> [... [, <Parameter N>]]])

<Control used>: Control name

Name of the control (or menu option) associated with the process (or event) to run.
For an option in a popup menu, use the following notation: <Name of popup menu>.<Option name>.
Caution: If the name of the control is not directly specified (with an indirection, for example), you must explicitly use the Value property.

<Process>: Integer constant

Event to be executed among the WLanguage events available for controls:
trtAction Action code of the Web Component control. This code is available in server code and in browser code.
This constant is not available.
trtAddDiagShape Code executed when a shape is added in a Diagram Editor control.
This constant is not available.
New in version 28
trtAddKanbanCard
Code executed when a card is added in a Kanban control.
This constant is not available.
trtAddToken Code executed when a token is added in a "Text token" Edit control.
This constant is not available.
trtAddWidget Code executed when a widget is added to a Dashboard control.
This constant is not available.
trtAfterOpeningDocument "After opening a document" code of the Word Processing, Image Editor, Spreadsheet and PDF Reader controls.
This constant is not available.
trtBeforeClosingDocument "Before closing a document" code of the Word Processing, Image Editor, Spreadsheet and PDF Reader controls.
This constant is not available.
trtBeforeCreatingOrganizerApt "Before creating the appointment" code of the Organizer control.
This constant is not available.
trtBeforeCreatingScheduleApt "Before creating the appointment" code of Scheduler control.
This constant is not available.
trtChange "Whenever modified" code of control.
This constant is not available.
trtChangeDiagShape Code executed when a shape is modified in a Diagram Editor control.
This constant is not available.
trtChangeOrganizerPeriod "Whenever changing period" code of Organizer control.
This constant is not available.
trtChangePlane "Whenever changing plane" code of a Sliding Banner control.
This constant is not available.
trtChangePositionMap "Whenever changing position" code of Map control.
This constant is not available.
trtChangeSchedulePeriod "Whenever changing period" code of Scheduler control.
This constant is not available.
trtClick Click code of the control.
trtClickButtonArrow Click code on the arrow associated with a button.
This constant is not available.
trtClickHTMLLink "Click on a link" code of an HTML Display control.
This constant is not available.
trtClickToken Click code on a token in a "Text token" Edit control.
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. For more details, see the remarks.
This constant is not available.
trtCollapseExpandBreak Collapsed/Expanded code of a break in a Looper or Table control.
This constant is not available.
trtCollapseExpandDrawer Browser code run each time the Drawer control is collapsed or expanded.
This constant is not available.
trtComboClosing Code executed when the drop-down list is closed.
This constant is not available.
trtComboOpening Code executed the drop-down list of a Combo Box control is expanded.
This constant is not available.
trtDelayedPlaneLoad "Delayed plane load" code of a plane.
This constant is not available.
trtDeleteDiagShape Code executed when a shape is deleted from a Diagram Editor control.
This constant is not available.
New in version 28
trtDeleteKanbanCard
Code executed when a card is deleted from a Kanban control.
This constant is not available.
trtDeleteOrganizerApt Code executed when an appointment is deleted from an Organizer control.
This constant is not available.
trtDeleteScheduleApt Code executed when an appointment is deleted from a Scheduler control.
This constant is not available.
trtDeleteToken Code executed when a token is deleted from a "Text token" Edit control.
This constant is not available.
trtDeleteWidget Code executed when a widget is deleted from a Dashboard control.
This constant is not available.
trtDoubleClick Double-click code.
This constant is not available.
trtEndChange "End of modification" code (Slider and Scrollbar control only).
This constant is not available.
trtEndInitialization "End of initialization" code (List Box, Table and Combo Box control based on a data file).
This constant is not available.
trtEndLoadingHTMLPage "After loading the HTML page" code of an HTML Display control.
This constant is not available.
New in version 28
trtEndMovingKanbanCard
Code executed when the user stops moving a card in a Kanban control.
This constant is not available.
trtEnter Entry code of the control.
trtEnterInputOrganizerApt Code executed when the user enters an appointment in an Organizer control.
This constant is not available.
trtEnterInputSchedulerApt Code executed when the user enters an appointment in a Scheduler control.
This constant is not available.
trtExit Exit code of the control.
trtInit Control initialization code.
This constant is not available.
New in version 28
trtKanbanCardDetails
Code executed when the details of a card are displayed in a Kanban control.
This constant is not available.
trtLineDisplay Code executed when a row is displayed (Table control only).
This constant is not available.
trtLineEnter Entry code of a row (Table control only).
This constant is not available.
trtLineExit Exit code of the row (Table control only).
This constant is not available.
trtLoadingHTMLResource "Load resources" code of an HTML Editor or HTML Display control.
This constant is not available.
trtMenuOption Code of a menu option (main or context menu).
This constant is not available.
trtModificationColumnFilter Code "Whenever modifying the filter (user input in header)" of a Table Column control.
This constant is not available.
trtModificationSpreadsheetCell "Cell modification" code of Spreadsheet control.
This constant is not available.
trtMoveDiagShape Code executed when the user moves a shape in a Diagram Editor control.
This constant is not available.
New in version 28
trtMoveKanbanCard
Code executed when the user moves a card in a Kanban control.
This constant is not available.
trtMoveOrganizerApt Code executed when the user moves an appointment in an Organizer control.
This constant is not available.
trtMoveScheduleApt Code executed when the user moves an appointment in a Scheduler control.
This constant is not available.
trtMoveWidget "Moving a widget" code of Dashboard control.
This constant is not available.
trtOrganizerInputExitApt Code executed when the user leaves the input field of an appointment in an Organizer control.
This constant is not available.
trtPullToRefresh "Pull to refresh" code of a Table or Looper control.
This constant is not available.
trtReadFirst Code executed when the first record is read (Table control only).
This constant is not available.
trtReadLast Code executed when the last record is read (Table control only)
This constant is not available.
trtReadNext Code executed when the next record is read (Table control only).
This constant is not available.
trtReadPrevious Code executed when the previous record is read (Table control only).
This constant is not available.
trtReassignResourceScheduleApt Code executed when an appointment is reassigned in a Scheduler control.
This constant is not available.
trtRefreshRibbon Code executed when the ribbon of the PDF Reader or Word Processing control is refreshed.
This constant is not available.
trtResizeDiagShape Code executed when a shape is resized in a Diagram Editor control.
This constant is not available.
trtResizeOrganizerApt Code executed when an appointment is resized in an Organizer control.
This constant is not available.
trtResizeScheduleApt Code executed when an appointment is resized in a Scheduler control.
This constant is not available.
trtResizeWidget "Resizing a widget" code of Dashboard control.
This constant is not available.
trtRightClick Right-click code (for TreeView controls only).
This constant is not available.
trtRightClickHTMLLink "Right click on a link" code of an HTML Display control.
This constant is not available.
trtScheduleInputExitApt Code executed when the user leaves the input field of an appointment in a Scheduler control.
This constant is not available.
trtSelectDiagShape Code executed when a shape is selected in a Diagram Editor control.
This constant is not available.
trtSelection Selection code (Combo Box, List Box and Table control).
This constant is not available.
trtSelectOrganizerApt Code executed when an appointment is selected in an Organizer control.
This constant is not available.
trtSelectOrganizerPeriod Code executed when a time range is selected in an Organizer control.
This constant is not available.
trtSelectScheduleApt Code executed when an appointment is selected in a Scheduler control.
This constant is not available.
trtSelectSchedulePeriod Code executed when a time range is selected in a Scheduler control.
This constant is not available.
trtSliderChange "Whenever modified" code (Slider control only).
This constant is not available.
trtSpinMinus Code executed when the value decreases in a Spin control.
This constant is not available.
trtSpinPlus Code executed when the value increases in a Spin control.
This constant is not available.
trtStartLoadingHTMLPage "Before loading the HTML page" code of an HTML Display control.
This constant is not available.
New in version 28
trtStartMovingKanbanCard
Code executed when the user starts moving a card in a Kanban control.
This constant is not available.
trtValueAssignment Code executed when the Value property of the Web Component control is assigned. This code is available in browser code only.
This constant is not available.
trtValueRetrieval Code executed when the Value property of a Web Component control is retrieved. This code is available in browser code only.
This constant is not available.
trtZoomModification Code executed when the zoom value changes in a Range Slider control.
This constant is not available.

Control or block of a report: Event to be executed among the available WLanguage events:
trtPostPrint "Post Print" code of a block.
This constant is not available.
trtPrePrint "Pre Print" code of control or block.
This constant is not available.

<Parameter 1>: Any optional type

First optional parameter to be passed to the code (for WLanguage events that expect parameters).

<Parameter N>: Any optional type

Nth optional parameter to be passed to the code (for WLanguage events that expect parameters).

Executing a WLanguage event associated with a window Hide the details

ExecuteProcess(<Window used> , <Process> [, <Parameter 1> [... [, <Parameter N>]]])

<Window used>: Window name

Name of the window with a WLanguage event to be executed.

<Process>: Integer constant

Event to be executed among the WLanguage events available for windows.
trtBeforeClosingWindow "Allow closing" code.
This constant is not available.
trtChange Code executed when the window is modified.
trtChangeLayout "Change of layout" code.
This constant is not available.
trtClick Code of the button associated with the click in the window.
This constant is not available.
trtClosing Window closing code.
trtDoubleClick Code of the button associated with the double click in the window.
This constant is not available.
trtGetFocus Code executed when the window gains focus.
This constant is not available.
trtKillFocus Code executed when the window loses focus.
This constant is not available.
trtOpening or trtInit Window initialization code.
trtRequestRefresh "Request for updating the display" code.
This constant is not available.
trtResize Code executed when the window is resized.
This constant is not available.
trtRightClick Code of the button associated with the right click in the window.
This constant is not available.
trtSystemButton "Before closing with OK/Close button" code.
This constant is only available for Android and iOS.

<Parameter 1>: Any optional type

First optional parameter to be passed to the code (for WLanguage events that expect parameters).

<Parameter N>: Any optional type

Nth optional parameter to be passed to the code (for WLanguage events that expect parameters).

Executing a WLanguage event associated with a page Hide the details

ExecuteProcess(<Page used> , <Process> [, <Parameter 1> [... [, <Parameter N>]]])

<Page used>: Page name

Name of the page with a WLanguage event to be executed.
The name of the page must be enclosed in quotes.

<Process>: Integer constant

Event to be executed among the WLanguage events available for pages.
trtChangeLayout
"Whenever changing layout" code of the page.
trtChangeSlice
"Whenever changing blade" code (page in Responsive Web Design mode).
trtClosing
Page closing code.
This constant has no effect.
trtInit
Page initialization code.
trtLoad
Code executed when the page is loaded.
trtOpening
Page opening code.
trtRequestRefresh
"Request for updating the display" code.
trtReset
Code executed when the page is reset (when a form is reset).
trtScroll
"Scroll" code of the page.
trtSubmit
Code executed when a page is submitted (when a form is sent).
trtUnload
Code executed when the page is unloaded.

<Parameter 1>: Any optional type

First optional parameter to be passed to the code (for WLanguage events that expect parameters).

<Parameter N>: Any optional type

Nth optional parameter to be passed to the code (for WLanguage events that expect parameters).

Executing a WLanguage event associated with a report Hide the details

ExecuteProcess(<Report used> , <Process> [, <Parameter 1> [... [, <Parameter N>]]])

<Report used>: Report name

Name of the report whose process must be run.

<Process>: Integer constant

event to be executed among the WLanguage events available for reports.
trtClosing Report closing code.
trtFilter Code executed when the report data is filtered.
trtOpening or trtInit Report opening code.
trtReadData Code executed when the report data is read.

<Parameter 1>: Any optional type

First optional parameter to be passed to the code (for WLanguage events that expect parameters).

<Parameter N>: Any optional type

Nth optional parameter to be passed to the code (for WLanguage events that expect parameters).

Executing a WLanguage procedure Hide the details

<Result> = ExecuteProcess(<WLanguage procedure> , <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.

<WLanguage procedure>: Procedure name

Name of procedure to execute.
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 execution 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.
a variable of type Procedure Description (usable only to execute a class method). For more details, see Enumerating and handling the objects of a class.

<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

Executing the "Collapse/Expand" event

For a TreeView control
The WLanguage "Collapse / Expand" event of a TreeView control expects the following two parameters:

<Element path>: Text variable containing the full path of the element currently collapsed or expanded. Simply specify the name of a variable. It will be automatically initialized at runtime.
<Collapsed>: Boolean variable, used to find out the action performed by the user (collapse = True, expand = False). Simply specify the name of a variable. It will be automatically initialized at runtime.

To execute this event with ExecuteProcess, you also need to specify these two parameters. In this case, the following syntax must be used:

ExecuteProcess(<TreeView control>, trtTreeviewExpandCollapse, <Element path>, <Collapsed>)

For more details on the "Collapse / Expand" code of a TreeView control, see WLanguage events associated with a TreeView control.

For a TreeView Table control
The WLanguage "Collapse / Expand" event of a TreeView Table control does not expect any parameters.

To execute this event with ExecuteProcess, use the following syntax:

ExecuteProcess(<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", trtProcédure)

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

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

Business / UI classification: Neutral code

Component: wd280vm.dll