ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
FOR statement
The statement block is repeated while a control variable is modified and compared to a limit value (before each beginning of statement block)...
RETURN statement
The RETURN statement is used to exit a statement block and the current process (or procedure).
CONTINUE statement/"CONTINUE:" label
The CONTINUE keyword can correspond:
  • to the CONTINUE instruction. It allows you to go back to the beginning of the first iteration without finishing the code of the current iteration.
  • to the CONTINUE: label. It allows you to declare a common code in a loop.
RETURN statement
The RETURN statement is used to exit the current event, process or procedure and return a result...
BREAK statement/"BREAK:" label
The keyword BREAK can correspond:
  • to the BREAK statement: it allows you to exit a set of instructions and run the rest of the current process.
  • to the BREAK label: it allows you to declare a section of code in a loop. This code will be run when exitingfrom the loop with a "BREAK" statement.
Functions for managing Map controls (prefix syntax)
The following functions are used to manage Map controls via prefix syntax
Functions for handling commands in console mode (prefix syntax)
Functions for handling commands in console mode.
Maximized windows for Android
A maximized window occupies the entire screen of the mobile device.
Constants used for managing the multi-touch
Constants for managing the multi-touch
ColorHue (Function)
Calculates the hue of a color.
Sensor constants
Constants used by the SensorXXX functions
RibbonAdaptSize (Function)
Adapts the size of the controls found in a Ribbon control according to the size of their caption.
Parameters of the procedure used by NearbyShareSend
WLanguage procedure ("callback") called by NearbyShareSend to notify whether or not the data was sent successfully.
Address (Variable type)
The Address type is used to manipulate the address of a place or person.
OpenChild (Function)
Opens a non-modal child window.
ContactCreate (Function)
Opens the native "Create contact" window of the device (Android, iPhone or iPad).
<Table>.ModifyLine (Function)
Modifies a row in:
  • a Table control,
  • a TreeView Table control.
GPSDetectPosition (Function)
Asks to be notified when the device gets close to a given location.
<Looper>.SearchEverywhere (Function)
Searches for a value in all the attributes of a Looper control.
Unalterable tables
This feature is used to signal that a table cannot be modified after writing...
SchedulerSelectedRange (Function)
Returns the start or end date and time of the time slot selected in a Scheduler control.
FaxResume (Function)
Re-enables a fax paused in the spooler (pending fax).
MatDelete (Function)
Deletes an existing matrix.
dRectangle (Function)
Draws a rectangle:
  • in an Image control,
  • in an Image variable,
  • in a WDPic variable (on the background layer),
  • in a picLayer variable.
Defining colors in Table controls
The colors of a Table control (row background, text of rows, etc.) are defined in the control description...
BrightnessAuto
The BrightnessAuto keyword allows you to adjust brightness on an Android or iOS device.
<Multiline Zone>.AddLine (Function)
Adds a new dynamic row into a Multiline Zone control.
<TreeView>.SelectCount (Function)
Returns the number of selected elements in a TreeView control (for a multi-selection TreeView control).
docElement (Variable type)
The docElement type is used to handle each element found in a docParagraph variable.
ArrayDistinct (Function)
Returns an array without duplicates.
WEBDEV - Browser code Note: This feature is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 2.
<Source>.DeactivateAutoFilter (Function)
Disables an automatic filter on the linked files when browsing an XML file.
SelectColor (Function)
Opens the standard window for color selection and selects the specified color.
<Image variable>.HorizontalSymmetry (Function)
Flips an image contained in an Image variable with respect to a horizontal axis (symmetry with respect to a horizontal axis).
Deploying an Android application
WINDEV Mobile allows you to develop Android applications. Then, these applications can be easily deployed.
PageChangeLayout (Function)
Applies a specific layout to a page.
mlzInsertLine (Function)
Inserts a new dynamic row in a Multiline Zone control.
DocEndModification (Function)
Signals the end of the grouping of a set of operations into a single event (undo/redo management).
LooperToXML (Function)
Creates an XML file with data from a Looper control (Looper control based on a table or populated programmatically).
MobileNetworkStatus (Function)
Returns the current status of the connection to data on the mobile network or asks to be notified when the status of the connection to data changes.
<TreeView>.CollapseAll (Function)
Collapses a branch previously expanded (as well as its child elements).
<Chart>.DeleteSeries (Function)
Deletes a data series from a chart.
ZOrder (Property)
The ZOrder property defines the Z-order of an element.
HCreateServerTrigger (Function)
Adds or modifies a server trigger on the HFSQL server.
iChangeSubReportSource (Function)
Modifies through programming the report associated with a sub-report in a composite report.
<Buffer>.AnsiToUnicode (Function)
Converts a buffer containing an ANSI string (Windows) to a buffer containing a UNICODE string.
<Tab>.Open (Function)
Opens a new pane in a Dynamic Tab control.
EmailListFolder (Example)
Usage example of the EmailListFolder function
<Source>.ExportXLS (Function)
Exports records from a table (HFSQL or OLE DB), view or query to an Excel file (XLSX).
HDeleteTask (Function)
Deletes a scheduled task from an HFSQL Client/Server server.
ServiceStop (Function)
Stops a service.
ArrayDelete (Function)
Deletes an element at a given position:
  • from a one-dimensional WLanguage array.
  • from an advanced array property (array of gglCalendar events, etc.).
  • from an associative array.
  • from a WLanguage list.
HClusterNodeInfo (Function)
Returns the status of each cluster node by interrogating the coordinator.
NULL values: Allowing nullable types
Starting with version 2024, you can allow nullable types in a WINDEV, WEBDEV or WINDEV Mobile project...
RegistryValueType (Function)
Returns the type of value found in the registry.
ScreenFirst (Function)
Defines the next control that will be in edit in the current window.
TelemetryIdentifyUser (Function)
Identifies the current user for whom the telemetry data is saved.
<Word Processing>.EndModification (Function)
Indicates the end of a series of actions performed in a Word Processing control in a single event ("undo/redo").
mqttSession (Variable type)
The mqttSession type is used to define the parameters for connecting to the MQTT broker.
HCreationIfNotFound (Function)
Performs the following operations:
  • If the table doesn't exist, create an empty table (file with ".FIC" extension) with the index file, the full-text index file and the memo file if necessary. The function is equivalent to HCreation.
  • If the table exists, opens the table.
WiFiSelectNetworkCard (Function)
Selects the Wi-Fi network card that will be used for the next calls to the WiFi functions.
<Chart>.PiePullOut (Function)
Pulls out a section (or all sections) in a chart.
<Chart>.SurfaceGridlines (Function)
Displays the gridlines for the different planes of a Surface chart.
ThreadStop (Function)
Stops a secondary thread. Function not recommended.
GPSInitParameter (Function)
Initializes the parameters of geolocation WLanguage functions and finds a location provider.
<Dashboard>.Display (Function)
Refreshes elements in a Dashboard control.
HexaToBuffer (Function)
Converts a string with hexadecimal bytes to a binary buffer.
<WDPic variable>.PixelColor (Function)
Identifies the color of a pixel contained in a WDPic variable.
Snap to grid
The different editors of WINDEV, WEBDEV and WINDEV Mobile allow you to align the elements via a snap-on grid...
Camera/Video functions (prefix syntax)
Closes the current browser window and stops the execution of the current code.
zipDeleteFileList (Function)
Deletes a list of files from an archive.
VideoCapture (Function)
Captures the images received from the camera:
  • as an image: take a photo.
  • as a video: record a video.
AndroidiPhone/iPad Function kept for "Version-26-compatible" Camera controls.
Managing WebSockets
WebSockets enable bidirectional communication between web applications (Intranet or Internet sites run in a browser) and web servers...
HCreationIfNotFound (Example)
Example of the HCreationIfNotFound function
xmlSignatureVerification (Variable type)
The xmlSignatureVerification type is used to define the information required to verify an XML signature.
<btleDevice variable>.Connect (Function)
Used to connect to a Bluetooth Low Energy device.
CurrentIndex (Function)
Depending on the specified control, returns:
  • the number of the current row displayed in the current Table control,
  • the number of the option with focus in a Check Box control,
  • the number of the current row in the current Looper control,
  • the index of the current indexed control.
Yousign
It is now common for individuals or businesses to sign contracts electronically...
gpwLogin (Function)
Connects a user to an application that uses the User Groupware.
MapDeleteAll (Function)
Deletes the following from a Map control:
  • all markers,
  • use any shape you want,
  • all images.
EmulateSimulator (Function)
Emulates the window of the mobile (Android/iOS) simulator.
Manipulating PDF files
PDF is one of the most widely used formats for sending and storing electronic documents...
<List Box>.Insert (Function)
Inserts an element into a List Box, ListView or Combo Box control populated programmatically.
AnimationGetParameter (Function)
Reads the value of one of the animation parameters defined for an Image or Static Text control.
Using Unicode in HFSQL tables
The database schema proposes two types of Unicode items ...
OCRParameter (Function)
Initializes the general options of the native OCR (Optical Character Recognition) system.
<Breadcrumb>.ModifyLink (Function)
Modifies a link in a Breadcrumb control.
<WDPic variable>.DrawTextMarkdown (Function)
Draws Markdown text in a variable of type WDPic.
<Window>.EdDo (Window)
Runs an action (defined programmatically) and enables Undo/Redo operations on this action.
Sidebar control features
The main characteristics of a Sidebar control can be configured...
GetDefinition (Function)
Retrieves the element type definition.
XMLValidNode (Function)
Validates an XML node, its children and its attributes from its description in the XSD schema linked to the XML document.
<Looper>.RefreshVisible (Function)
Changes or returns the visibility status of the refresh bar in a Looper control.
<Source>.EndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
TokenListSeparator (Property)
The TokenListSeparator property retrieves or modifies the separators that trigger the creation of new tokens when entering information in a "Text token" Edit control.
TableMoveBranch (Function)
Moves the content of a row as well as its entire descending tree structure in a TreeView Table control.
<sfConnection variable>.SeekDeleted (Function)
Seeks and retrieves the records (Salesforce objects) deleted during the specified period.
Link properties
When creating a link, you can simply specify the destination...
OrganizerListAppointment (Function)
Returns:
  • the list of appointments found between two dates in an Organizer control,
  • all appointments found in an Organizer control,
  • a specific appointment (selected or hovered).
FileView (Function)
Opens a file in the browser.
HClusterMasterNode (Function)
Returns the name of the master node in an HFSQL cluster.
TypeVar (Function)
Identifies the type of an expression, a variable (during a call to a procedure for example) or a control.
<Connection variable>.DeleteScheduling (Function)
Delete a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
IntegerToDayInAlpha (Function)
Returns the name of the day corresponding to a specified date (this date is an integer).
Count (Function)
Returns the number of occurrences of a control in a window, in a page or in a group of controls.
ToastDisplayIW (Function)
Opens a toast whose content is based on an internal window.
fDecrypt (Function)
Decrypts a file that was encrypted by fCrypt.
grLineThickness (Function)
Retrieves and/or modifies the value of the line thickness in a line chart.
TableSelectPlus (Function)
Selects a row in a Table or TreeView Table control.
<Image>.DrawBorder (Function)
Draws the borders in an Image control.
<picLayer variable>.PixelOpacity (Function)
Identifies the opacity of a pixel in a WDPicLayer image with an Alpha channel.
UsefulHeight (Property)
The UsefulHeight property gets and sets the useful height of an internal window (or supercontrol) with scrollbars.
<Array>.MoveLine (Function)
Allows you to:
  • move a row in a two-dimensional array or in an advanced array property. The other array rows are moved accordingly.
  • swap two rows in a two-dimensional array or in an advanced array property.
Types of charts available
WINDEV, WEBDEV and WINDEV Mobile propose different types of charts...
<upnpDevice variable>.GetMute (Function)
Retrieves the 'Mute' status of a UPnP device.
AJAXExecuteAsynchronous (Function)
Executes a server procedure without refreshing the page.
<PDF Reader>.Open (Function)
Opens a PDF file displayed in a PDF Reader control.
ContactEdit (Function)
Opens the details of a contact in edit mode in the default application of the device (Android, iPhone, iPad).
SearchAAF (Property)
The SearchAAF property is used to:
  • find out whether the search via AAF is enabled on a non-editable Combo Box control,
  • enable (or not) the search via AAF on a non-editable Combo Box control.
KeyFileType (Property)
The KeyFileType property defines the type of encoding used for a key file.
<Connection variable>.TransactionStart (Function)
Starts a transaction on the tables (HFSQL or accessed via Native Access) and creates the transaction table.
Handling the external files
WINDEV, WINDEV Mobile and WEBDEV propose several functions allowing you to manage the external files from your WINDEV/WINDEV Mobile applications or from your WEBDEV websites...
<Connection variable>.ListWatchedFiles (Function)
Returns the list of tables watched by HWatch.
KanbanListIndex (Function)
Returns the index of a list in a Kanban control.
SQLListSource (Function)
Lists the data sources declared on a local site.
Properties associated with reports and controls
List of properties associated with the reports and their controls
<picLayer variable>.DrawRectangleGradient (Function)
Draws a rectangle in a picLayer variable.
LEDSwitchOn (Function)
Switches the LED (Light-Emitting Diode) of the device on.
<Looper>.SelectCount (Function)
Returns the number of selected rows in a Looper control.
<Connection variable>.DescribeServerTrigger (Function)
Adds or modifies a server trigger.
docElementCheckBox (Variable type)
The docElementCheckBox type allows you to define all the advanced characteristics of a check box used in a form.
Manager of automated tests
The test manager is used to...
FlexJustifyContent (Property)
The FlexJustifyContent property gets and sets the alignment of items in the Flexbox control along the main axis (corresponding CSS property: "justify-content").
LooperSearchEverywhere (Function)
Searches for a value in all the attributes of a Looper control.
zipOpen (Function)
Opens an existing archive.
TrustedCertificateReset (Function)
Removes all the certificates added by TrustedCertificateAdd.
docElementText (Variable type)
The DocElementText type is used to handle the characteristics of a Text element found in a DocElement variable.
<Table>.Count (Function)
Returns:
  • the number of columns found in a Table or TreeView Table control.
  • the number of rows found in a Table or TreeView Table control.
Description window of a combining query
The description window of a combining query consists of several sections...
Code editor: Snake_case or PascalCase
There are several naming conventions to write variables in the code...
BTLEDisconnect (Function)
Used to disconnect from a Bluetooth Low Energy device.
PanelDetach (Function)
Detaches a Dockable Panel control to transform it into a floating window.
Importing a CSS style sheet
WEBDEV gives you the ability to import a CSS style sheet into a WEBDEV project...
<TreeView>.GiveChild (Function)
Returns the "children" of an element found in a TreeView control.
Replace (Function)
Replaces all occurrences of a specified substring in a string with another specified substring.
PositionOccurrence (Function)
Finds the Xth position of a string within another string.
Phone (Variable type)
The Phone type is used to handle a phone number as well as its type (home, work, ...).
Specific features of iPhone/iPad applications
To simplify the reading in the controls used to view large volumes of data, the end user has the ability to zoom the data found in the control...
<mongoCollection variable>.ExecuteCommand (Function)
Runs a generic command on a MongoDB collection.
<Source>.ChangeDir (Function)
Changes the path to a table (i.e. directory in which the file will be handled).
MapItineraryDistance (Function)
Calculates the distance of an itinerary in a Map control.
WINDEV 2026 Update
Here are the new features and improvements that you will discover in this version...
grRealTimeInterval (Function)
Sets the time interval visible in a time chart with real-time display.
EmulateInfo (Function)
Emulates the next call to Info and automatically clicks the "OK" button.
SelectedTextWithTag (Property)
The SelectedTextWithTag property is used to get or change the text selected in a rich edit control (RTF or HTML) with HTML or RTF formatting tags.
<Unicode string>.RegexSearch (Function)
Searches for all the parts of a string that match a specific format.
<Image variable>.DrawShadow (Function)
Adds a shadow effect on an image found in an Image variable.
ListAdd (Function)
Adds an element to a List Box, ListView or Combo Box control populated programmatically.
<Image>.SaveGIF (Function)
Saves an image:
  • in a file in GIF format.
  • in memory.
<sfConnection variable>.Disconnect (Function)
Disconnects:
  • the Salesforce platform.
  • the current Salesforce session.
TableEnumBreak (Function)
Enumerates the breaks found in a Table control.
ActiveXEvent (Function)
Associates a procedure written in WLanguage with an event of ActiveX control.
Global procedure/function
A global procedure can be used in all the processes or events of the project.
<Chart>.SaveBMP (Function)
Saves a chart that was previously drawn in a file in BMP format.
OKCancel (Function)
Displays a message in a standard dialog box that proposes "OK" and "Cancel" and returns the user's choice.
grSeriesColor (Function)
Initializes the color of a series or the color of a section.
HTTPCookieGet (Function)
Retrieves the cookies read by a call:
PicSave (Function)
Saves the image found:
  • in an Image Editor control.
  • in a WDPic variable.
EmailSeekFirst (Function)
Finds one or more emails according to the criteria specified in the messaging software (Outlook, messaging software using the IMAP protocol, ...).
WiFiDeleteNetwork (Function)
Deletes a network from the list of Wi-Fi networks configured on the device.
Width (Property)
The Width property gets and changes the width:
  • of a control or block in a report.
  • of a control (found in a window), window, column found in a table or column found in a list box (including listview).
  • of a control (found in a page), column found in a table or column found in a list box. The control can be overlayable or not.
WinBackgroundImage (Function)
Modifies the background image of a window and specifies the display mode of this image.
MatchRegularExpression (Function)
Checks whether a character string matches a specific format and retrieves the different substrings that match the format.
Map control functions
Map control functions
Trace (Function)
Displays the requested information (content of a control, for example) in a window opened next to the current window.
RTFAdd (Function)
Adds a character string (in RTF or not) at the end of RTF edit control, RTF control in a report or character string containing a text in RTF.
Secure REST web service
WINDEV and WEBDEV allow you to create REST web services and secure access with OAuth tokens...
Project description: Theme tab
The project description window allows you to configure various elements of your project...
<Image>AnimationGetParameter (Function)
Reads the value of one of the animation parameters defined for an Image field.
<Chart>.DonutHolePercentage (Function)
Modifies the percentage corresponding to the radius of the hole in a Donut chart.
<Word Processing>.Seek (Function)
Finds a character string in an entire Word Processing control.
Manipulating Word Processing controls programmatically
Word Processing controls can be manipulated programmatically...
gpwBiometricAuthentication (Function)
Enables biometric authentication for the connected user or retrieves the current status for the connected user.
LoadDLL (Function)
Loads the specified library (DLL) in memory.
NumberPage (Property)
The NumberPage property is used to get:
  • the number of pages in a "multi-page" image file. This image is displayed in an Image control or in the background of a Chart control.
  • the number of pages in a PDF file displayed in an Image control.
  • the number of pages found in a PDF file displayed in a PDF Reader control.
  • the number of pages found in a DOCX file displayed in a Word Processing control.
<Window>.EdSave (Function)
Saves the changes made when the "Modification of UI by the end user" mode is enabled.
SchedulerTaskProperties (Function)
Reads the properties of a scheduled task and updates the ScheduledTask structure.
HSortView (Function)
Sorts an HFSQL view by creating an index on a view item. This function uses the former view mechanism.
<emailSMTPSession variable>.StartSession (Function)
Starts an SMTP session.
Facebook constants
The following constants are used by the functions for managing Facebook connections:
<Gantt chart>.AddHoliday (Function)
Defines a new holiday period on a row in a Gantt Chart column in a Table or TreeView Table control.
HMigrateLinkedCompositeKey (Function)
Migrates the values of the linked composite keys coming from a file in Hyper File 5.5 format to the HFSQL Classic format.
StatMin (Function)
Calculates the minimum value for a series of values.
MyGuidedTour
The MyGuidedTour variable is used to handle the current Guided Tour. The MyGuidedTour variable is used to get the characteristics of the GuidedTour variable used.
ScanGet (Function)
Retrieves the characteristics of a scanner in a variable of type Scanner.
gglMarker (Variable type)
The gglMarker type is used to define the characteristics of a marker that must be positioned on a map...
LooperSearch (Function)
Searches for a value in an attribute of a Looper control.
<ANSI string>.Right (Function)
Extracts the last characters from a string or string buffer.
Configuring the browser "Back" button
The "Back" button allows users to see the history of pages they previously visited...
Writing an email
Writing an email in WLanguage consists in filling the email structure of WLanguage...
<DiskFile variable>.Lock (Function)
Entirely or partially locks an external file.
<Spreadsheet>.InsertRow (Function)
Inserts an empty row into a Spreadsheet control found in a window.
Managing geolocation and GPS
WINDEV Mobile and WEBDEV allow you to exploit geolocation and GPS features found on mobile devices and browsers.
<zipArchive variable>.ListFile (Function)
Returns the list of files found in an archive.
LoWord (Function)
Returns the two low bytes of an integer.
Deploying an application that uses an external component
An application that uses one or more external components is deployed in the same way as a standard application...
1
…
7
8
9