ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2025
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)...
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.
RETURN statement
The RETURN statement is used to exit a statement block and the current process (or procedure).
RETURN statement
The RETURN statement is used to exit the current event, process or procedure and return a result...
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.
Constants for managing XML documents
List of constants used by the functions for managing XML documents.
Functions for managing Map controls (prefix syntax)
The following functions are used to manage Map controls via prefix syntax
Constants used for managing the multi-touch
Constants for managing the multi-touch
Maximized windows for Android
A maximized window occupies the entire screen of the mobile device.
HtmlFormat (Property)
The HtmlFormat property is used to:
  • find out whether an edit control accepts the input in HTML format.
  • modify the input format of an edit control.
Operations performed on sequence diagrams
The following paragraphs explain...
<docFragment variable>.ClearFormatting (Function)
Replaces the current formatting of a selection with the default formatting.
RTFToHTML (Function)
Returns the HTML string corresponding to the specified RTF string.
<Multiline Zone>.AddLine (Function)
Adds a new dynamic row into a Multiline Zone control.
1. Application overview
WINDEV Mobile tutorial: Developing an Android and iOS application Lesson 1 - Application overview - 10 min
RibbonAdaptSize (Function)
Adapts the size of the controls found in a Ribbon control according to the size of their caption.
Address (Variable type)
The Address type is used to manipulate the address of a place or person.
ContactCreate (Function)
Opens the native "Create contact" window of the device (Android, iPhone or iPad).
<TreeView>.Sort (Function)
Sorts the elements found in a TreeView control.
EnumerationFromValue (Function)
Returns an enumeration value known by its associated value.
<Table>.ModifyLine (Function)
Modifies a row in:
  • a Table control,
  • a TreeView Table control.
Instantiating an object
To access a class, the object must be declared as being part of the class to handle, this is called object instantiation...
MatFill (Example)
Usage example of the MatFill function
Sensor constants
Constants used by the SensorXXX functions
Parameters of the procedure used by NearbyShareSend
WLanguage procedure ("callback") called by NearbyShareSend to notify whether or not the data was sent successfully.
ColorHue (Function)
Calculates the hue of a color.
The Dockable Panel control
The Dockable Panel control allows you to easily organize the software interface into zones that the end user can freely move...
Unalterable tables
This feature is used to signal that a table cannot be modified after writing...
Error 1009: The member of the class is private
Constants for managing the multi-touch
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).
StyleID (Property)
The StyleID property gets and sets the identifier of the style associated with an element.
MatDelete (Function)
Deletes an existing matrix.
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.
<TreeView>.SelectCount (Function)
Returns the number of selected elements in a TreeView control (for a multi-selection TreeView control).
grScatter3DAddData (Function)
Adds a new point to display in a 3D Scatter chart.
Defining colors in Table controls
The colors of a Table control (row background, text of rows, etc.) are defined in the control description...
HClusterNodeInfo (Function)
Returns the status of each cluster node by interrogating the coordinator.
OpenChild (Function)
Opens a non-modal child window.
docElement (Variable type)
The docElement type is used to handle each element found in a docParagraph variable.
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.
DateTimeToEpoch (Function)
Converts a local datetime to Epoch format (number of time units since 01/01/1970 at 00h00 UTC).
RegistryValueType (Function)
Returns the type of value found in the registry.
<Source>.DeactivateAutoFilter (Function)
Disables an automatic filter on the linked files when browsing an XML file.
1. Components provided with WINDEV
WINDEV is provided with projects that contain components.
GPSDetectPosition (Function)
Asks to be notified when the device gets close to a given location.
zipNbPartNeeded (Example)
Usage example of the zipNbPartNeeded function
Configuring the assisted universal replication
If your application uses assisted universal replication via a .WER file, the setup creation wizard proposes to configure the setup to install the different tools required for this type of replication.
Coloring a row, a column or a cell found in a control (AAF)
To simplify the reading in the controls used to view large volumes of data, the end user has the ability to color the data found in the control...
The "Area" charts
The Area chart is used to highlight the amplitude of a change...
PageChangeLayout (Function)
Applies a specific layout to a page.
<Looper>.SearchEverywhere (Function)
Searches for a value in all the attributes of a Looper control.
The AWP technology (Active WEBDEV Page)
PC SOFT proposes a new technology...
DocEndModification (Function)
Signals the end of the grouping of a set of operations into a single event (undo/redo management).
CmdGetExitCode (Function)
Gets the exit code of the command executed in console mode, i.e. the value returned when the command finishes executing.
Using WDMSG
The different steps for translating the project messages with WDMSG are as follows:
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.
EmailGetIndicator (Function)
Retrieves the indicators defined on an email of IMAP session.
<TreeView>.CollapseAll (Function)
Collapses a branch previously expanded (as well as its child elements).
<Stack variable>.Pop (Function)
Pops an element from a stack.
<Chart>.DeleteSeries (Function)
Deletes a data series from a chart.
InsertReference (Function)
Adds the reference of an object at given position in a one-dimensional array.
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.
<Tab>.Close (Function)
Closes a dynamic pane in a Tab control.
HRecordDate (Function)
Returns the date and time of last write operation performed on a record in an HFSQL table (Classic or Client/Server).
IndentFirstLine (Property)
The IndentFirstLine property gets and sets the indent of the first line of an element.
<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.
WINDEV 2025 Tutorial - Table of contents
Seeks and retrieves the records (Salesforce objects) deleted during the specified period.
gCircle (Function)
Builds a sequence of characters containing a circle or an ellipse.
Keyword properties
You can change the characteristics of a keyword at any time in the keyword properties...
tapiCallDuring (Function)
Returns the duration of the call (difference between the start date and time of call and the end date and time of call).
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.
SpreadsheetDeleteImage (Function)
Deletes an image from the current worksheet in a Spreadsheet control.
SelectColor (Function)
Opens the standard window for color selection and selects the specified color.
Page constants
List of constants used by page functions.
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.
sfError (Variable type)
The sfError type is used to find out the characteristics of an error returned by Salesforce...
NULL values: Allowing nullable types
Starting with version 2024, you can allow nullable types in a WINDEV, WEBDEV or WINDEV Mobile project...
SubCaption (Property)
The SubCaption property gets and sets the secondary caption of:
  • an option in a Radio Button or Check Box control.
  • an element of a TreeMap control.
  • a QuickAction variable.
IntegerToDayInAlpha (Function)
Returns the name of the day corresponding to a specified date (this date is an integer).
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.
StartDatePeriodDisplayed (Property)
The StartDatePeriodDisplayed property gets the start date of the range displayed in a Scheduler or Organizer control of a report.
<Word Processing>.EndModification (Function)
Indicates the end of a series of actions performed in a Word Processing control in a single event ("undo/redo").
<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).
mqttSession (Variable type)
The mqttSession type is used to define the parameters for connecting to the MQTT broker.
<Command variable>.ReadStandardOutput (Function)
Reads standard output data, for the command executed in console mode.
Deploying an Android application
WINDEV Mobile allows you to develop Android applications. Then, these applications can be easily deployed.
Setup mode
Several methods can be used to distribute a WINDEV application...
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.
mlzInsertLine (Function)
Inserts a new dynamic row in a Multiline Zone control.
<Menu>.Delete (Function)
Deletes a menu or a menu option.
<Chart>.SurfaceGridlines (Function)
Displays the gridlines for the different planes of a Surface chart.
ThreadStop (Function)
Stops a secondary thread. Function not recommended.
How to avoid displaying the URL of WEBDEV pages in the browser?
By default, when the user connects to a site developed with WEBDEV, the address bar of the browser contains an address in the following format...
SysEnvironment (Function)
Returns the environment variables of the operating system for the current computer.
EpochToDateTime (Function)
Converts a date and a time in Epoch format (number of time units since 01/01/1970 at 00h00 UTC) to a local datetime.
15. Project Management Hub
Changes or returns the visibility status of the refresh bar in a Looper control.
<Dashboard>.Display (Function)
Refreshes elements in a Dashboard control.
HexaToBuffer (Function)
Converts a string with hexadecimal bytes to a binary buffer.
OAuth and OpenID protocol functions
OAuth and OpenID protocol functions
<WDPic variable>.PixelColor (Function)
Identifies the color of a pixel contained in a WDPic variable.
WEBDEV administrator: Advanced configuration
The "Advanced" tab enables you to configure advanced options of the server...
1. WLanguage functions specific to WEBDEV
Seeks and retrieves the records (Salesforce objects) deleted during the specified period.
SysNameExe (Function)
Returns the name and full path of an application.
DLNA/UPnP functions
The following WLanguage functions are used to handle UPnP devices
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.
Minute (Property)
The Minute property gets and sets the minutes of an element.
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.
9. Queries
Reads the data found on the output buffer of the SSH session.
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...
MenuAddSeparator (Function)
Adds a new separator in a menu (drop-down or context menu).
4. Monitor your applications
Displays the first image for the scroll.
HCreationIfNotFound (Example)
Usage example of the HCreationIfNotFound function
Table,Modify (External language)
Modifies an element in a Table control.
<PolygonGeo variable>.Intersect (Function)
Checks whether the intersection of a geographic polygon and another geometry does not result in an empty set.
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.
DateToDayOfYear (Function)
Returns the day of the year corresponding to a given date.
How to create and run an SQL query through programming?
This help page explains how to create and run an SQL query through programming.
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.
PreviousStep (Property)
The PreviousStep property defines whether or not the user can go to the previous step of a Guided Tour.
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.
dSaveImage (Function)
dSaveImage is kept for backward compatibility.
Characteristics of Sidebar controls
The main characteristics of a Sidebar control can be configured...
ImageLast (Function)
Displays the last image for the scroll.
zipNbFile (Example)
Usage example of the zipNbFile function
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.
7. Source Code Manager (SCM)
A window can:
  • Receive parameters when it is opened.
  • Return values when it is closed.
<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...
Report viewer: "Search" pane
A search feature is automatically available when previewing a report...
MaxLineHeight (Property)
The MaxLineHeight property gets and sets the maximum height in:
  • the rows of a Table control (case of multiline rows with automatic resizing).
  • the rows of a TreeView Table control.
  • the rows of a Looper control.
5. User Groupware in practice
Closes the current browser window and stops the execution of the current code.
Recycle bin functions
List of functions for managing the recycle bin
Modbus functions
List of Modbus functions
DDERecipient (Function)
Identifies the recipient of a DDE connection.
<sshSession variable>.Read (Function)
Reads the data found on the output buffer of the SSH session.
rssCategory (Variable type)
The rssCategory type is used to handle the category of a RSS feed or stream entry.
<Image>.First (Function)
Displays the first image for the scroll.
xlsMsgError (Function)
Returns the caption of the last error caused by an XLS function.
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).
ReplicDeleteSubscription (Function)
Deletes the subscription of a replication on the replication server.
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.
Extensions of files created by WINDEV, WEBDEV, WINDEV Mobile
The table below presents the main extensions of files created and supported by WINDEV, WEBDEV and WINDEV Mobile...
gpwCheckPassword (Function)
Checks a password (encrypted or not).
<Connection variable>.DeleteScheduling (Function)
Delete a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
InSeconds (Property)
The InSeconds property is used to convert a Duration variable to seconds.
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.
Comparing the project messages
The comparison between source and target text helps you find translation errors...
Count (Function)
Returns the number of occurrences of a control in a window, in a page or in a group of controls.
PublicationDate (Property)
The PublicationDate property gets the date an element was last accessed.
ToastDisplayIW (Function)
Opens a toast whose content is based on an internal window.
<Window>.EdSelect (Function)
Returns one of the controls selected when the interface is modified by the end user ("Allow end users to modify the UI" option enabled).
GeometryLength (Function)
Calculates the length of a given geometry.
TableSelectPlus (Function)
Selects a row in a Table or TreeView Table control.
<mqttSession variable>.Disconnect (Function)
Allows you to disconnect from a MQTT server (also called "Broker").
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.
Connection (Property)
The Connection property gets and sets the connection associated with a table.
<mongoGridFS variable>.ListFile (Function)
Retrieves the list of MongoDB files found in the MongoDB file system (gridFS).
<Menu>.Clone (Function)
Clones a menu or a menu option as well as the associated code.
<Stack variable>.Info (Function)
Retrieves the characteristics of a stack: types of elements and number of elements.
<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.
10. Page templates
Determines if a cell is merged with other cells and gets the merged cell range.
UsefulHeight (Property)
The UsefulHeight property gets and sets the useful height of an internal window (or supercontrol) with scrollbars.
YAxisMax (Property)
The YAxisMax property gets the maximum value of the Y-axis in a Chart control. This property can be used in the "Zoom" event of a Chart control to identify the section displayed.
<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.
GPSInitParameter (Function)
Initializes the parameters of geolocation WLanguage functions and finds a location provider.
Types of charts available
WINDEV, WEBDEV and WINDEV Mobile propose different types of charts...
The Pager control
The Pager control is used to quickly access the records of a Table or Looper control displayed on several pages...
<upnpDevice variable>.GetMute (Function)
Retrieves the 'Mute' status of a UPnP device.
AJAXExecuteAsynchronous (Function)
Executes a server procedure without refreshing the page.
PageAddress (Function)
Used to find out the Internet address of a page.
<PDF Reader>.Open (Function)
Opens a PDF file displayed in a PDF Reader control.
12. Control templates
Control templates
1
2
3
4
5
6
…
9
>