ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2025
<Word Processing>.FormatPainterMode (Function)
Enables the format painter mode in the Word Processing control or determines if this mode is enabled.
SysIconDisplayTooltip (Function)
Displays a tooltip for an icon found in the taskbar.
ChronoStart (Function)
Starts a stopwatch to measure the duration of a process (in milliseconds) and resets a running stopwatch.
ChronoValue (Function)
Indicates the time elapsed (in milliseconds) since the call to ChronoStart.
ChronoEnd (Function)
Stops a stopwatch and returns the time elapsed (in milliseconds) since the start of timing (call to ChronoStart).
How do I run a data file with a filter?
<Word Processing>.InsertTable (Function)
Inserts a table into a Word Processing control.
ProgressBarExecute (Function)
Starts a long browser process and fill a Progress Bar via AJAX according to the progress of this process.
ErrorPropagate (Function)
Propagates a non-fatal error that can be processed by the calling code if the management of non-fatal errors was enabled for this code (in the code editor or by ErrorChangeParameter).
<Table>.RefreshVisible (Function)
Modifies or returns the visibility status of refresh bar in a Table or TreeView Table control.
ChronoResume (Function)
Restarts a stopwatch that was stopped by ChronoEnd or ChronoPause.
<Chrono>.Pause (Function)
Pauses a stopwatch in order to measure the time spent on a process.
<Chrono>.Resume (Function)
Resumes a stopwatch previously stopped by <Chrono>.Fin or <Chrono>.Pause.
ProgressBarEnable (Function)
Enables the refresh of a Progress Bar via AJAX.
IMAP protocol
The IMAP protocol is a standard protocol for managing emails...
ChronoPause (Function)
Pauses a stopwatch in order to measure the time spent on a process.
<Word Processing>.Undo (Function)
Undoes the last action performed on a Word Processing control.
<Word Processing>.Print (Function)
Prints the content of a Word Processing control in "docx" format.
<Word Processing>.ExitEdit (Function)
Exits from the current edit. The entry in edit was performed by DocGoIntoEdit.
HOnError (Example)
Usage example of the HOnError function
Managing the emails with the POP3/SMTP protocols
The POP3 and SMTP protocols are protocols for email management recognized by all Internet Service Providers...
InWebMode (Function)
Indicates whether the current process is run:
  • from a WINDEV executable.
  • from the WEBDEV runtime engine (AWP).
<Word Processing>.Redo (Function)
Restores the last undone action on a Word Processing control.
TableRefreshVisible (Function)
Modifies or returns the visibility status of refresh bar in a Table or TreeView Table control.
LooperRefreshVisible (Function)
Changes or returns the visibility status of the refresh bar in a Looper control.
ExceptionThrow (Function)
Artificially triggers the security mechanism of WLanguage by throwing an exception.
<Word Processing>.UndoRedoDeleteAll (Function)
Deletes the entire history of the Undo/Redo mechanism for a Word Processing control.
<Word Processing>.GoIntoEdit (Function)
Enters Word Processing control in a specific part of the document: body, header or footer.
<Word Processing>.Close (Function)
Closes the docx file associated with the Word Processing control and frees the document.
<Looper>.RefreshVisible (Function)
Changes or returns the visibility status of the refresh bar in a Looper control.
<Word Processing>.ToText (Function)
Creates a character string from the data of a Word Processing control.
<Word Processing>.Select (Function)
Selects a fragment in a Word Processing control.
<Word Processing>.FindElementByName (Function)
Searches for an element by its name in a Word Processing document.
fSelect (Example)
Usage example of the fSelect function
<Word Processing>.RedoCount (Function)
Returns the number of canceled actions that can be redone on a Word Processing control.
<Word Processing>.EndModification (Function)
Indicates the end of a series of actions performed in a Word Processing control in a single event ("undo/redo").
<Word Processing>.UndoCount (Function)
Returns the number of actions that can be undone in a Word Processing control.
HourGlass (Function)
Transforms the mouse cursor into hourglass and vice versa.
In Android and iOS, displays an endless progress bar in a window.
DocInsertTable (Function)
Inserts a table into a Word Processing document.
docElement (Variable type)
The docElement type is used to handle each element found in a docParagraph variable.
<Word Processing>.ToImage (Function)
Exports a page from a Word Processing control in image format.
JSEvent (Function)
Associates a browser procedure with an event on an object in browser code.
InWindowsMobileMode (Function)
Indicates whether the code is run:
  • from a Windows Mobile application.
  • from a WINDEV application, from a WEBDEV website or from a PHP application.
Function kept for backward compatibility.
NetEraseFile (Function)
Deletes a file from the FTP (File Transfer Protocol) or RPC (Remote Procedure Call) server powered by WINDEV.
This function is kept for backward compatibility.
<Word Processing>.ToPDF (Function)
Converts a Word Processing document into a PDF file.
<Word Processing>.ClearFormatting (Function)
Replaces the current formatting of a selection in a Word Processing control with the default formatting.
ExceptionEnable (Function)
Re-enables the current exception process if the exception was corrected.
ErrorAsynchronous (Function)
Displays a custom error message in a non-blocking system error window.
<Chrono>.Start (Function)
Starts a stopwatch to measure the duration of a process (in milliseconds) and resets a running stopwatch.
<Chrono>.End (Function)
Stops a stopwatch and returns the time elapsed (in milliseconds) since the start of timing (call to <Chrono>.Start).
HourglassNetwork (Function)
Shows or hides an infinite progress bar in the title bar of Android application windows.
This function is no longer available from version 2024.
<Word Processing>.InfoXY (Function)
For a given position (coordinates of a point) in a Word Processing control, returns one of the following:
  • the number of the corresponding page,
  • the corresponding X-position (in mm),
  • the corresponding Y-position (in mm).
FOR EACH/FOR ALL statement (loop through controls)
The statement FOR EACH is used to perform different types of browse on the controls (List Box, Table or Looper controls)...
<Word Processing>.Replace (Function)
Finds all the instances of a character string and replaces them with another string in a Word Processing control.
NetRenameFile (Function)
Renames or moves a file located on the FTP (File Transfer Protocol) or RPC (Remote Procedure Call) server created with WINDEV.
This function is kept for backward compatibility.
iEndPrinting (Function)
Signals the end of the document to print and actually starts printing the data stored in the printer spooler via the following functions: iPrint, iPrintImage, iNewLine, etc.
General exception mechanism
A process of general exception is available for all the components of the object with which it is associated...
<Word Processing>.Save (Function)
Saves a document as a "docx" file.
Managing Hive databases
Hive is a software layer of Hadoop used to run queries...
<Word Processing>.Seek (Function)
Finds a character string in an entire Word Processing control.
HSimulateNetwork (Function)
Simulates the operating mode of HFSQL Client/Server on an ADSL or 3G network.
OLECreateEmpty (Function)
Associates an OLE control with an OLE object by invoking a specific OLE server.
HNoModif (Function)
Forbids all the modifications on a data file (for all the programs, including the one that requested the no-modification policy).
ContactSource (Variable type)
The type ContactSource type is used to define all the advanced characteristics of a contact source (or account) (e.g. Google, Exchange, Facebook).
OLECreateCopy (Function)
Associates an OLE control with an OLE object while specifying a base file.
ScanToImage (Function)
Retrieves a document from a scanner in a variable of type Image.
<Word Processing>.Open (Function)
Opens a Word Processing file (docx format) in Read/Write mode. The docx file is opened and locked until it is closed.
BTLEStatus (Function)
Returns the current Bluetooth activation status on the device or asks to be notified when the activation status changes.
docElementCheckBox (Variable type)
The docElementCheckBox type allows you to define all the advanced characteristics of a check box used in a form.
<Scanner variable>.ToImage (Function)
Retrieves a document from a scanner in a variable of type Image.
WinRefreshVisible (Function)
Modifies or returns the visibility state of the refresh bar in a window.
HErrorStatusModification (Function)
Returns the status of a record during a modification conflict.
HCancelSeek (Function)
Cancels the current search criterion.
Linux application: Tips and tricks
In multi-configuration Windows/Linux applications, various limitations may arise: unmanaged fields, unavailable functions, etc.
XMLSavePosition (Function)
Stores the current position in the XML document.
<Source>.CancelSeek (Function)
Cancels the current search criterion.
InTSEMode (Function)
Indicates whether the code is run:
  • from a computer in TSE mode or from a remote desktop.
  • from a computer directly.
docNumbering (Variable type)
The docNumbering type is used to define the advanced characteristics of a numbering used in a Word Processing document.
HOut (Function)
Used to find out whether the record on which you want to be positioned is located outside the data file, filter, view or query.
Creating an interactive diagram
The Diagram Editor control allows end users to create and edit diagrams...
InAJAXMode (Function)
Specifies whether the code is run from:
Message (Function)
Displays or removes a message from the status bar of the current window or browser.
dbgInfo (Function)
Returns a debug information.
BackgroundTaskAdd (Function)
Adds a new background task.
<Word Processing>.Insert (Function)
Inserts an object in a Word Processing control. The objects that can be used are:
  • an element,
  • a document,
  • a paragraph,
  • a text,
  • an image,
  • a fragment.
docSection (Variable type)
The docSection type is used to define the advanced characteristics of a section found in a document or paragraph.
<btleDevice variable>.ConnectionStatus (Function)
Returns the current connection status to a Bluetooth Low Energy device or asks to be notified when the connection status changes.
<Word Processing>.ToHTML (Function)
Converts the content of a Word Processing control into an HTML file.
RequestRefreshUIElement (Function)
Requests the execution of the "Request for refreshing the display" event of the specified element (and gives back control without waiting for the execution of the event).
<Word Processing>.Position (Function)
Triggers the scroll of Word Processing control in order for the requested text to be entirely displayed.
<Word Processing>.StartModification (Function)
Indicates the start of a series of actions performed in a Word Processing control in a single event ("undo/redo").
KeyPressed (Function)
Checks which key is pressed.
New (Reserved word)
New is used to allocate memory space...
Internal procedure
Several features require a procedure called once or several times via a WLanguage function ("Callback").
NetOpenRemoteAccess (Function)
Establishes a remote connection.
<Source>.ExecuteSQLQueryAsynchronous (Function)
Executes an SQL query asynchronously.
HExecuteSQLQueryAsynchronous (Function)
Executes an SQL query asynchronously.
Managing WebSockets
The WebSockets are used to communicate from a Web application (Intranet or Internet site run in a browser) to a Web server by using sockets...
HLockFile (Function)
Locks a data file and restricts the access to this data file for all other sites or applications.
GPSGetPosition (Function)
Retrieves information about the current device position.
<Source>.LockFile (Function)
Locks a data file and restricts the access to this data file for all other sites or applications.
<Source>.ActivateFilter (Function)
Enables the filter that was previously created for the specified data file (view or query).
HActivateFilter (Function)
Enables the filter that was previously created for the specified data file (view or query).
HEndNoDatabaseAccess (Function)
Re-allows the access (which means the connection) to one or more databases accessible via a connection.
HFreeQuery (Function)
Releases query resources (following use of HExecuteQuery or HExecuteSQLQuery functions).
<Source>.FreeQuery (Function)
Releases query resources (following use of HExecuteQuery or HExecuteSQLQuery functions).
<Source>.ErrorStatusModification (Function)
Returns the status of a record during a modification conflict.
<Word Processing>.Add (Function)
Adds an element, document, paragraph, text, image or fragment at the end of a Word Processing control.
HDeactivateFilter (Function)
Temporarily disables the filter on a data file (view or query).
<Source>.DeactivateFilter (Function)
Temporarily disables the filter on a data file (view or query).
NumberColumn (Property)
The NumberColumn property is used to:
  • Get the number of columns in Table, Check Box, Radio Button controls, etc..
  • Set the number of columns in a multi-column List Box control.
<Element>.RequestRefreshUI (Function)
Requests the execution of the "Request for refreshing the display" event of the specified element (and gives back control without waiting for the execution of the event).
BTLEConnectionStatus (Function)
Returns the current connection status to a Bluetooth Low Energy device or asks to be notified when the connection status changes.
EmulateError (Function)
Emulates the next call to Error and automatically clicks the "OK" button.
DocOpen (Function)
Opens a Word Processing file (docx format) in Read/Write mode. The docx file is opened and locked until it is closed.
ReplicOpen (Function)
Opens a replication in direct mode or with a replication server.
Selection (Property)
The property Selection property displays the characteristics of the selection (or cursor):
  • in a Word Processing control.
    Note: This selection is located in the part being edited (body, header or footer).
  • in a Spreadsheet control.
  • in an HTML Editor control.
  • in a Diagram Editor control.
DocToHTML (Function)
Converts a Word Processing document into an HTML file.
RequestUpdateUI (Function)
Requests the execution of the "Request for refreshing the display" event (and gives back control without waiting for the execution of the event). This function is kept for backward compatibility.
JSONExecute (Function)
Calls the URL of a page on the server that returns data in JSON format (JavaScript Object Notation).
Buttons within the input area of an Edit control
You can include different buttons in the input area of an Edit control...
HLockRecNum (Function)
Locks a record and restricts the access to this record for all the other applications.
sOpen (Function)
Opens and initializes:
  • a serial port.
  • a parallel port.
  • an infrared port.
NotifPushEnable (Function)
Enables the management of push notifications in a WINDEV Mobile application (Android or iOS).
<Source>.LockRecNum (Function)
Locks a record and restricts the access to this record for all the other applications.
ParallelTaskExecute (Function)
Triggers the execution of a parallel task.
HTTPGetResult (Function)
Retrieves the result or the header of last HTTP request run.
RequestRefreshUI
Requests the execution of the "Request for refreshing the display" event (and gives back control without waiting for the execution of the event).
HFilter (Function)
Defines and enables a filter on a data file, view or query.
<Source>.Filter (Function)
Defines and enables a filter on a data file, view or query.
HNext (Function)
Sets the position on the next data file record according to a browse item.
<Source>.Next (Function)
Sets the position on the next data file record according to a browse item.
HPrevious (Function)
Sets the position on the previous record of the data file according to a browse item.
<Source>.Previous (Function)
Sets the position on the previous record of the data file according to a browse item.
sClose (Function)
Closes the specified serial port, parallel port or infrared port.
EmailReadMessageHeader (Function)
Reads the header of an incoming email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
HLast (Function)
Sets the position on the last record of a data file according to a browse item.
<Source>.Last (Function)
Sets the position on the last record of a data file according to a browse item.
JWTParameters (Variable type)
The JWTParameter type is used to define all the data required for JWT-based authentication.
BTLEListDevice (Function)
Returns the list of accessible Bluetooth Low Energy devices.
Other operators
The following are additional operators...
Telephony: Managing incoming calls
The management of the incoming calls is performed in a specific "thread".
docNumberingLevel (Variable type)
The docNumberingLevel type is used to define the advanced characteristics of a numbering level used in a Word Processing document.
ConfirmAsynchronous (Function)
Displays a non-blocking message in a standard dialog box with the answers "Yes", "No", "Cancel" and calls a WLanguage procedure with the user's response.
SQLTable (Function)
Transfers the result of a query to a Table control populated programmatically (a List Box or Combo Box control), with the possibility of Partial Fetch (the result is retrieved by blocks of rows).
<Source>.First (Function)
Sets the position on the first record of a data file according to the specified browse item.
HFirst (Function)
Sets the position on the first record of a data file according to the specified browse item.
HReadPrevious (Function)
Sets the position on the previous record of a file according to a browse item.
Starting WDOptimizer in a command line
<Source>.ReadPrevious (Function)
Sets the position on the previous record of a file according to a browse item.
BackgroundTaskDelete (Function)
Deletes a background task (that was added by BackgroundTaskAdd).
Reading an email
This help page explains how to read an email from a WINDEV application and how to display its content in a WINDEV application.
Characteristics of Table controls in a window
Table controls allow you to display and/or enter data...
HReadNext (Function)
Sets the position on the next data file record according to a browse item.
HReadLast (Function)
Sets the position on the last record of a data file according to a browse item.
<Source>.ReadLast (Function)
Sets the position on the last record of a data file according to a browse item.
EmailStartOutlookSession (Function)
Allows you to access data handled by the Outlook messaging software (emails, contacts, groups of contacts, tasks, appointments and folders).
Confirm (Function)
Displays a message in a standard dialog box that proposes "Yes", "No", "Cancel" and returns the user's choice.
HImportText (Function)
Imports a Text file into an HFSQL Classic or Client/Server data file. This data file must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
<Source>.ReadSeek (Function)
Sets the position on the first record whose value for a specific item is greater than or equal to a sought value (generic search).
HReadSeek (Function)
Sets the position on the first record whose value for a specific item is greater than or equal to a sought value (generic search).
EncryptStandard (Function)
Encrypts a character string or a binary buffer by using a symmetrical encryption algorithm (AES, DES, etc.)
sParameter (Function)
Defines or modifies the parameters for configuring the specified serial port, parallel port or infrared port.
HReadFirst (Function)
Positions on the first file record according to a browse item.
HEndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
HImportHF55 (Function)
Imports a Hyper File 5.5 file into an HFSQL Classic file.
TimerSys (Function)
Periodically and automatically calls a WLanguage procedure.
<Source>.EndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
<Source>.ImportHF55 (Function)
Imports a Hyper File 5.5 file into an HFSQL Classic file.
Data persistence
The data persistence is used to store the value typed by the user...
<Source>.LogRestart (Function)
Restarts the logging process on a file.
Translating a text file with WDTRAD
EmulateInfo (Function)
Emulates the next call to Info and automatically clicks the "OK" button.
NULL values: Allowing nullable types
Starting with version 2024, you can allow nullable types in a WINDEV, WEBDEV or WINDEV Mobile project...
EmulateWarning (Function)
Emulates the next call to Warning and automatically clicks the "OK" button.
Permission (Variable type)
The Permission type represents a permission requested by the application (and therefore declared in the manifest).
docFormatMulticolumn (Variable type)
The docFormatMulticolumn type is used to define all the advanced characteristics of a multicolumn section defined in a docSection variable.
HLogRestart (Function)
Restarts the logging process on a file.
AdjustmentMode (Property)
The AdjustmentMode property determines and changes how a Spreadsheet control is adjusted in a report.
HLogStop (Function)
Stops the log process of a file.
EmulateDialog (Function)
Emulates the next call to Dialog and automatically clicks the button passed as parameter.
EmulateYesNo (Function)
Emulates the next call to YesNo and automatically clicks the button specified as parameter.
EmulateOKCancel (Function)
Emulates the next call to OKCancel and automatically clicks the button passed as parameter.
EmulateConfirm (Function)
Emulates the next call to Confirm and automatically clicks the button passed as parameter.
<Source>.LogStop (Function)
Stops the log process of a file.
OLELoad (Function)
Initializes an OLE control with an OLE object.
HReadSeekFirst (Function)
Sets the position on the first record whose value for a specific item is strictly equal to a sought value (exact-match search).
<Source>.ReadSeekFirst (Function)
Sets the position on the first record whose value for a specific item is strictly equal to a sought value (exact-match search).
RulerValue (Property)
The RulerValue property is used to get or change the position of the playhead in a TimeLine control.
HashCheckFile (Function)
Checks the Hash of a file for a specific type of algorithm.
HashCheckString (Function)
Checks the Hash of a character string for a specific type of algorithm.
1
…
8