ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
<Page>.Use (Function)
Displays a WEBDEV page in the browser of the Web user and closes all the current page contexts.
Using an external component in an application
A component can be reused at any time in any application...
Testing a dynamic project from a test server
Before deploying your dynamic WEBDEV website, we recommend that you run the final tests from a test sever...
Error 1004: To explicitly access an element of the base class '%1', use the syntax
Usage example of the zipNbFile function
UsefulHeight (Property)
The UsefulHeight property gets and sets the useful height of an internal window (or supercontrol) with scrollbars.
5. User Groupware in practice
Closes the current browser window and stops the execution of the current code.
<PDF Reader>.Open (Function)
Opens a PDF file displayed in a PDF Reader control.
NotesReset (Function)
Creates an empty document in Lotus Notes.
HClusterMasterNode (Function)
Returns the name of the master node in an HFSQL cluster.
ServiceStop (Function)
Stops a service.
MapDeleteAll (Function)
Deletes the following from a Map control:
  • all markers,
  • use any shape you want,
  • all images.
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...
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.
ContactCreate (Function)
Opens the native "Create contact" window of the device (Android, iPhone or iPad).
Configuring 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.
<Table>.ModifyLine (Function)
Modifies a row in:
  • a Table control,
  • a TreeView Table control.
OpenChild (Function)
Opens a non-modal child window.
GPSDetectPosition (Function)
Asks to be notified when the device gets close to a given location.
Unalterable tables
This feature is used to signal that a table cannot be modified after writing...
REST web service: Calling a web service function
RESTSend is used to call a REST webservice function.
<emailSMTPSession variable>.StartSession (Function)
Starts an SMTP session.
AJAXExecuteAsynchronous (Function)
Executes a server procedure without refreshing the page.
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.
Functions for managing Map controls (prefix syntax)
The following functions are used to manage Map controls via prefix syntax
12. Control templates
Control templates
ContactEdit (Function)
Opens the details of a contact in edit mode in the default application of the device (Android, iPhone, iPad).
The Pager control
The Pager control is used to quickly access the records of a Table or Looper control displayed on several pages...
RegistryValueType (Function)
Returns the type of value found in the registry.
1. Components provided with WINDEV
WINDEV is provided with projects that contain components.
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.
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...
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.
<Window>.EdSave (Function)
Saves the changes made when the "Modification of UI by the end user" mode is enabled.
<Word Processing>.Seek (Function)
Finds a character string in an entire Word Processing control.
Using WDMSG
The different steps for translating the project messages with WDMSG are as follows:
Map control functions
Map control functions
MatchRegularExpression (Function)
Checks whether a string matches a specific format and retrieves the different substrings that match the format.
EmailSeekFirst (Function)
Finds one or more emails according to the criteria specified in the messaging software (Outlook, messaging software using the IMAP protocol, ...).
PicSave (Function)
Saves the image found:
  • in an Image Editor control.
  • in a WDPic variable.
<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.
<Chart>.DonutHolePercentage (Function)
Modifies the percentage corresponding to the radius of the hole in a Donut chart.
grSeriesColor (Function)
Initializes the color of a series or the color of a section.
Scheduler control: Customize appointments
In the Scheduler control, the appointment is displayed in a specific area...
Animating the image display (WEBDEV)
The Web sites propose several transition effects between the elements:
<picLayer variable>.PixelOpacity (Function)
Identifies the opacity of a pixel in a WDPicLayer image with an Alpha channel.
NULL values: Allowing nullable types
Starting with version 2024, you can allow nullable types in a WINDEV, WEBDEV or WINDEV Mobile project...
10. Page templates
Determines if a cell is merged with other cells and gets the merged cell range.
StyleDrawCaptionGrayed (Function)
Customizes how text is drawn in grayed out controls.
mqttSession (Variable type)
The mqttSession type is used to define the parameters for connecting to the MQTT broker.
Deploying an Android application
WINDEV Mobile Tutorial: Deploying an Android application 10 min
<Chart>.PiePullOut (Function)
Pulls out a slice (or the whole part ) of a chart.
fDecrypt (Function)
Decrypts a file that was encrypted by fCrypt.
GPSInitParameter (Function)
Initializes the parameters of geolocation WLanguage functions and finds a location provider.
WINDEV 2026 Update
Here are the new features and improvements that you will discover in this version...
ListAdd (Function)
Adds an element to:
  • a List Box control populated programmatically,
  • WINDEV a Carousel control,
  • a Combo Box control populated programmatically,
  • Versions 2026 and later
    AndroidiPhone/iPad a Wheel control.
    Note: This control is only available from version 2026 - Update 2.
    Subscription-exclusive new feature
    AndroidiPhone/iPad a Wheel control.
    Note: This control is only available from version 2026 - Update 2.
    New in version 2026
    AndroidiPhone/iPad a Wheel control.
    Note: This control is only available from version 2026 - Update 2.
    AndroidiPhone/iPad a Wheel control.
    Note: This control is only available from version 2026 - Update 2.
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.
BTLEDisconnect (Function)
Used to disconnect from a Bluetooth Low Energy device.
Installing a WEBDEV website with zero-downtime update
Starting with version 24, you can update a Session or AWP site without disconnecting users...
Using objects
To access a class, the object must be declared as being part of the class to handle, this is called object instantiation...
DriveCopyFile (Function)
Copies a single file on a remote drive to another directory on same drive.
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.
Zombie tables and items
During the life of an application, items live and die...
zipOpen (Function)
Opens an existing archive.
<sfConnection variable>.SeekDeleted (Function)
Seeks and retrieves the records (Salesforce objects) deleted during the specified period.
MultiPoint2D (Variable type)
The MultiPoint2D type is used to store a set of points defined with 2D coordinates. It is a collection of points: unlike in a linestring, points are not connected.
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.
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...
Phone (Variable type)
The Phone type is used to handle a phone number as well as its type (home, work, ...).
PositionOccurrence (Function)
Finds the Xth position of a string within another string.
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.
OKCancel (Function)
Displays a message in a standard dialog box that proposes "OK" and "Cancel" and returns the user's choice.
DisplayedItem (Property)
The DisplayedItem property is used to:
  • Get the item or the variable displayed by the control.
  • Set the item or the variable displayed by the control.
<List Box>.Insert (Function)
Inserts an element in:
  • a List Box control populated programmatically.
  • a Combo Box control populated programmatically.
  • Versions 2026 and later
    AndroidiPhone/iPad a Roller field.
    Warning: This field type is only available from version 2026 Update 2.
    Subscription-exclusive new feature
    AndroidiPhone/iPad a Roller field.
    Warning: This field type is only available from version 2026 Update 2.
    New in version 2026
    AndroidiPhone/iPad a Roller field.
    Warning: This field type is only available from version 2026 Update 2.
    AndroidiPhone/iPad a Roller field.
    Warning: This field type is only available from version 2026 Update 2.
Code editor: Snake_case or PascalCase
There are several naming conventions to write variables in the code...
SaaSAdminSubscriptionDeallocateLicense (Function)
Cancels a subscription license for a SaaS user.
<Connection variable>.DescribeServerTrigger (Function)
Adds or modifies a server trigger.
Configuring the titles of columns (Table control)
The title of table columns is an important element of Table control...
Internal component description
The description of an internal component can opened at any time...
GetDefinition (Function)
Retrieves the element type definition.
<Source>.ChangeDir (Function)
Changes the path to a table (i.e. directory in which the file will be handled).
Creating an interactive diagram
The Diagram Editor control allows end users to create and edit diagrams...
ImageLast (Function)
Displays the last image for the scroll.
<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...
<Image>.First (Function)
Displays the first image for the scroll.
ReplicDeleteSubscription (Function)
Deletes the subscription of a replication on the replication server.
XMLValidNode (Function)
Validates an XML node, its children and its attributes from its description in the XSD schema linked to the XML document.
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.
<WDPic variable>.DrawTextMarkdown (Function)
Draws Markdown text in a variable of type WDPic.
Managing WebSockets
WebSockets enable bidirectional communication between web applications (Intranet or Internet sites run in a browser) and web servers...
4. Monitor your applications
Displays the first image for the scroll.
<Breadcrumb>.ModifyLink (Function)
Modifies a link in a Breadcrumb control.
Manipulating PDF files
PDF is one of the most widely used formats for sending and storing electronic documents...
<Looper>.SearchEverywhere (Function)
Searches for a value in all the attributes of a Looper control.
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.
HCreationIfNotFound (Example)
HCreationIfNotFound example
<Looper>.RefreshVisible (Function)
Changes or returns the visibility status of the refresh bar in a Looper control.
Report viewer: "Find" pane
A search feature is automatically available when previewing a report...
ThreadStop (Function)
Stops a secondary thread. Function not recommended.
RTFToHTML (Function)
Returns the HTML string corresponding to the specified RTF string.
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.
"Area" charts
An Area chart highlights the magnitude of changes in data...
rssCategory (Variable type)
The rssCategory type is used to handle the category of a RSS feed or stream entry.
<Tab>.Open (Function)
Opens a new pane in a Dynamic Tab control.
Address (Variable type)
The Address type is used to manipulate the address of a place or person.
DocEndModification (Function)
Signals the end of the grouping of a set of operations into a single event (undo/redo management).
DateTimeToEpoch (Function)
Converts a local datetime to Epoch format (number of time units since 01/01/1970 at 00h00 UTC).
SchedulerWorkingHourResource (Function)
Used to indicate the specific working hours per day and per resource in a Scheduler control.
<Image>.Occurrence (Function)
Returns the total number of images taken into account by the scroll.
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...
WDContinueError: Resume after error
This function forces the execution to resume after an error...
<Connection variable>.TransactionStart (Function)
Starts a transaction on the tables (HFSQL or accessed via Native Access) and creates the transaction table.
MVP RAD
WINDEV proposes an MVP RAD that generates the "table" and "form" windows as well as the necessary Presenter and Model classes...
pdfAttachment (Variable type)
The pdfAttachment type is used to define all the advanced characteristics of an attachment in a PDF document.
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...
MenuAddSeparator (Function)
Adds a new separator in a menu (drop-down or context menu).
1. Communication with WINDEV Mobile
WINDEV Mobile includes several communication functions for different fields.
Native Informix Connector: Requirements and remarks
Remarks and specific features of Native Informix Connector
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
Error 530: The -- operator is not allowed
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...
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 disable the search option via the AAF in a non-editable Combo Box control.
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...
LooperSearchEverywhere (Function)
Searches for a value in all the attributes of a Looper control.
Comparing the project messages
The comparison between source and target text helps you find translation errors...
What is a database?
A database is an organized collection of data for a particular purpose (e.g., manage orders)...
Count (Function)
Returns the number of occurrences of a control in a window, in a page or in a group of controls.
1. Application overview
WINDEV Mobile tutorial: Developing an Android and iOS application Lesson 1 - Application overview - 10 min
1. WLanguage functions specific to WEBDEV
Seeks and retrieves the records (Salesforce objects) deleted during the specified period.
<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.
zipDeleteFileList (Function)
Deletes a list of files from an archive.
SysNameExe (Function)
Returns the name and full path of an application.
<Connection variable>.NotifDeleteCCRecipient (Function)
Deletes the recipients of a notification sent via the Control Centers (WDBal messaging tool).
RibbonAdaptSize (Function)
Adapts the size of the controls found in a Ribbon control according to the size of their caption.
SysEnvironment (Function)
Returns the environment variables of the operating system for the current computer.
PanelDetach (Function)
Detaches a Dockable Panel control to transform it into a floating window.
Exp (Function)
Calculates the exponential of a numeric value (reverse of Napierian logarithm).
Importing a CSS style sheet
WEBDEV gives you the ability to import a CSS style sheet into a WEBDEV project...
Replace (Function)
Replaces all occurrences of a specified substring in a string with another specified substring.
Error 1009: The member of the class is private
Constants for managing the multi-touch
WDMap: Print records
WDMAP allows you to print the records found in a table...
WEBDEV administrator: Advanced configuration
The "Advanced" tab enables you to configure advanced options of the server...
TableSelectPlus (Function)
Selects a row in a Table or TreeView Table control.
<mongoGridFS variable>.ListFile (Function)
Retrieves the list of MongoDB files found in the MongoDB file system (gridFS).
MapItineraryDistance (Function)
Calculates the distance of an itinerary in a Map 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").
SelectedTextWithTag (Property)
The SelectedTextWithTag property is used to get or set the text selected in a rich edit control (RTF or HTML) with HTML or RTF formatting tags.
<Image variable>.DrawShadow (Function)
Adds a shadow effect on an image found in an Image variable.
SysThumbnailDeleteButton (Function)
Deletes one of the buttons found in the thumbnail of the application from the taskbar.
BTOpenDeviceProperties (Function)
Opens the window of properties for a Bluetooth device.
TestCheckNull (Function)
Checks whether an expression is Null in assertive programming and in automated test mode.
ScreenFirst (Function)
Defines the next control that will be in edit in the current window.
<Image>.SaveGIF (Function)
Saves an image:
  • in a file in GIF format.
  • in memory.
nWDInitProject: Project initialization code
Run the project initialization code...
<sfConnection variable>.Disconnect (Function)
Disconnects:
  • the Salesforce platform.
  • the current Salesforce session.
sfError (Variable type)
The sfError type is used to find out the characteristics of an error returned by Salesforce...
TableEnumBreak (Function)
Enumerates the breaks found in a Table control.
6. Printing the product catalog
WINDEV Mobile Tutorial - Developing an Android and iOS application Lesson 6 - Printing the product catalog - 20 min
<Chart>.Scatter3DAltitudeColor (Function)
Defines the different colors used according to the altitude levels of a series found in a 3D Scatter chart.
Global procedure/function
A global procedure can be used in all the processes or events of the project.
ERR_DISCONNECTED_EXEC
Displays the next plane of a Sliding Banner control.
3. Multi-criteria search
WINDEV Tutorial: Managing data in a WINDEV application Lesson 3 - Multi-criteria search - 40 min
<Chart>.SaveBMP (Function)
Saves a chart that was previously drawn in a file in BMP format.
HCreationIfNotFound (Function)
Performs the following operations:
  • If the table does not exist, creates an empty table (".FIC" extension) with the index, full-text index, spatial index, semantic index and memo files if necessary. This function is equivalent to HCreation.
  • If the table exists, opens the table.
MatDelete (Function)
Deletes an existing matrix.
Address (Property)
The Address property is used to:
  • Establish a connection between the Conference control (and the associated stream) and the receiver. This property is equivalent to StreamConnect.
  • Get the address of the last outgoing connection request.
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).
InsertReference (Function)
Adds the reference of an object at given position in a one-dimensional array.
2. Web development and WEBDEV
WEBDEV Tutorial: WEBDEV overview Lesson 2: Web development and WEBDEV - 10 min
Information 2102: 'Long' does not exist anymore: the integers are coded on 4 bytes
Downloads a file from a remote drive to the user's computer.
<Chart>.DeleteSeries (Function)
Deletes a data series from a chart.
TabMDI (Property)
The TabMDI property is used to:
  • Get the type of a Tab control (simple tab or dynamic tab - MDI).
  • Change the type of a Tab control (simple tab or dynamic tab - MDI).
This property is obsolete from version 200057. Use DynamicTab.
EmailGetIndicator (Function)
Retrieves the indicators defined on an email of IMAP session.
2. WEBDEV administrator in practice
Builds a sequence of characters containing a line.
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.
Width (Property)
The Width property gets and sets 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.
SelectColor (Function)
Opens the standard window for color selection and selects the specified color.
Setup by stand-alone physical media
A setup by stand-alone physical media allows you to provide a media that contains all the files required for installing and running a site...
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...
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.
Project description: Theme tab
The project description window allows you to configure various elements of your project...
The Progress Bar control
The Progress Bar control is used to follow the progress of an event...
<upnpDevice variable>.GetMute (Function)
Retrieves the 'Mute' status of a UPnP device.
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.
Manipulating Word Processing controls programmatically
Word Processing controls can be manipulated programmatically...
LoadDLL (Function)
Loads the specified library (DLL) in memory.
docElement (Variable type)
The docElement type is used to handle each element found in a docParagraph variable.
InPocketSimulatorMode (Function)
Indicates whether the code is run in the Pocket simulator.
Function kept for backward compatibility.
Root (Function)
Returns the root of a number.
External components for different platforms
Components are a remarkably useful tool for development teams...
HRecordDate (Function)
Returns the date and time of last write operation performed on a record in an HFSQL table (Classic or Client/Server).
HSortView (Function)
Sorts an HFSQL view by creating an index on a view item. This function uses the former view mechanism.
ToastDisplayIW (Function)
Opens a toast whose content is based on an internal window.
1
…
9