ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
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.
SecurityHtml (Property)
The SecurityHtml property gets and sets the status of the security mechanism of HTML Display and HTML Editor controls.
Internal component description
The description of an internal component can opened at any time...
Site testing: the different types of tests available
WEBDEV includes multiple methods for testing your sites...
KanbanFilter (Function)
Displays only cards that match the specified filter.
KeyExpression (Property)
The KeyExpression property is used to set the different components of a composite key.
Creating a delete query
A delete query (corresponding SQL statement...
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.
<Chart>.PiePullOut (Function)
Pulls out a section (or all sections) in a chart.
DriveCopyFile (Function)
Copies a single file on a remote drive to another directory on same drive.
The "Area" charts
The Area chart is used to highlight the amplitude of a change...
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.
LooperRefreshVisible (Function)
Changes or returns the visibility status of the refresh bar in a Looper control.
grLineThickness (Function)
Retrieves and/or modifies the value of the line thickness in a line chart.
The Organizer control
The Organizer control is used to display and handle organizers...
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).
SaaSAdminPricingEnableService (Function)
Enables a service in a SaaS pricing.
DownloadGetInfo (Function)
Retrieves the details of a download present in the download manager.
PageChangeLayout (Function)
Applies a specific layout to a page.
<Chart>.SaveBMP (Function)
Saves a chart that was previously drawn in a file in BMP format.
<Menu>.Delete (Function)
Deletes a menu or a menu option.
<Chart>.DeleteSeries (Function)
Deletes a data series from a chart.
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.
Types of charts available
WINDEV, WEBDEV and WINDEV Mobile propose different types of charts...
<Pivot Table>.Collapse (Function)
Collapses all the data in a Pivot Table control according to a row or column header.
WEBDEV - Server codeLinux Note: This feature is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 4.
<Chart>.DonutHolePercentage (Function)
Modifies the percentage corresponding to the radius of the hole in a Donut chart.
ContactEdit (Function)
Opens the details of a contact in edit mode in the default application of the device (Android, iPhone, iPad).
SaaSAdminSubscriptionDeallocateLicense (Function)
Cancels a subscription license for a SaaS user.
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.
KeyFileType (Property)
The KeyFileType property defines the type of encoding used for a key file.
sfError (Variable type)
The sfError type is used to find out the characteristics of an error returned by Salesforce...
Importing a CSS style sheet
WEBDEV gives you the ability to import a CSS style sheet into a WEBDEV project...
HTTPCookieGet (Function)
Retrieves the cookies read by a call:
OOP concepts
A class contains the description of a data structure (members) and the processes (methods) that handle this structure.
xlsMsgError (Function)
Returns the caption of the last error caused by an XLS function.
Connection (Property)
The Connection property gets and sets the connection associated with a table.
gpwLogin (Function)
Connects a user to an application that uses the User Groupware.
WDMap: Print records
WDMAP allows you to print the records found in a table...
ScanToImage (Function)
Retrieves a document from a scanner in a variable of type Image.
Setup mode
Several methods can be used to distribute a WINDEV application...
<Dashboard>.Display (Function)
Refreshes elements in a Dashboard control.
RegistryValueType (Function)
Returns the type of value found in the registry.
mqttSession (Variable type)
The mqttSession type is used to define the parameters for connecting to the MQTT broker.
Minute (Property)
The Minute property gets and sets the minutes of an element.
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.
ServiceStop (Function)
Stops a service.
ContactCreate (Function)
Opens the native "Create contact" window of the device (Android, iPhone or iPad).
<btleDevice variable>.Connect (Function)
Used to connect to a Bluetooth Low Energy device.
Yousign
It is now common for individuals or businesses to sign contracts electronically...
HCreateServerTrigger (Function)
Adds or modifies a server trigger on the HFSQL server.
<Tab>.Close (Function)
Closes a dynamic pane in a Tab control.
<List Box>.Insert (Function)
Inserts an element into a List Box, ListView or Combo Box control populated programmatically.
ZOrder (Property)
The ZOrder property defines the Z-order of an element.
<Stack variable>.Pop (Function)
Pops an element from a stack.
Sidebar control features
The main characteristics of a Sidebar control can be configured...
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.
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.
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.
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.
<Menu>.Clone (Function)
Clones a menu or a menu option as well as the associated code.
rssCategory (Variable type)
The rssCategory type is used to handle the category of a RSS feed or stream entry.
GPSDetectPosition (Function)
Asks to be notified when the device gets close to a given location.
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).
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.
OpenChild (Function)
Opens a non-modal child window.
Global procedure/function
A global procedure can be used in all the processes or events of the project.
<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...
ToastDisplayIW (Function)
Opens a toast whose content is based on an internal window.
OKCancel (Function)
Displays a message in a standard dialog box that proposes "OK" and "Cancel" and returns the user's choice.
DisplayMask (Property)
The DisplayMask property is used to:
  • Get the display mask.
  • Modify the display mask.
This display mask is displayed when the control is in read-only or when the control does not have focus.
<Source>.Previous (Function)
Sets the position on the previous record of the table according to a browse item.
Maximized windows for Android
A maximized window occupies the entire screen of the mobile device.
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.
HInitSubscriber (Function)
Initializes the range of automatic identifiers for the description file of subscriber replica (".rpl" extension).
Referring to an element in a WLanguage event / process
Used to manage the horizontal position (X-coordinate) of print cursor in the page.
PageAddress (Function)
Used to find out the Internet address of a page.
<Source>.CheckMemo (Function)
Checks the structural integrity of memos in an HFSQL table.
Managing geolocation and GPS
WINDEV Mobile and WEBDEV allow you to exploit geolocation and GPS features found on mobile devices and browsers.
<Email variable>.LoadAttachment (Function)
Adds an attached file to an email.
<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...
REST web service: Testing and deployment
WINDEV and WEBDEV allow you to create REST web services. Once the REST web service has been developed, you can:
  • Test and debug the REST web service.
  • Deploy the REST web service.
Configuring the browser "Back" button
The "Back" button allows users to see the history of pages they previously visited...
Configuring the titles of columns (Table control)
The title of table columns is an important element of Table control...
KanbanListIndex (Function)
Returns the index of a list in a Kanban control.
SQLListSource (Function)
Lists the data sources declared on a local site.
<picLayer variable>.DrawRectangleGradient (Function)
Draws a rectangle in a picLayer variable.
Selected (Property)
The Selected property lets you know if an item is selected and select an item.
<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").
MapDeleteImage (Function)
Deletes an image drawn on the map displayed in a Map 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...
Creating an Android widget
Widgets are small applications that can be displayed on the home screen of phones or tablets...
Boolean (Variable type)
The Boolean type is recommended for all logical operations where only two alternatives are possible...
NotesReset (Function)
Creates an empty document in Lotus Notes.
<ANSI string>.Right (Function)
Extracts the last characters from a string or string buffer.
DisplayedItem (Property)
The DisplayedItem property is used to:
  • Find out the item or the variable displayed by the control.
  • Modify the item or the variable displayed by the control.
gglMarker (Variable type)
The gglMarker type is used to define the characteristics of a marker that must be positioned on a map...
StatMin (Function)
Calculates the minimum value for a series of values.
grSeriesColor (Function)
Initializes the color of a series or the color of a section.
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.
Audits
Audits provide a set of features to automatically improve the project quality and performance, and to monitor the conditions in which it is implemented...
<Window>.EdSave (Function)
Saves the changes made when the "Modification of UI by the end user" mode is enabled.
HSortView (Function)
Sorts an HFSQL view by creating an index on a view item. This function uses the former view mechanism.
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).
LoadDLL (Function)
Loads the specified library (DLL) in memory.
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.
Pivot Table control functions (prefix syntax)
Pivot Table control functions (prefix syntax)
The Progress Bar control
The Progress Bar control is used to follow the progress of an event...
ListAdd (Function)
Adds an element to a List Box, ListView or Combo Box control populated programmatically.
Project description: Theme tab
The project description window allows you to configure various elements of your project...
<Image>.SaveGIF (Function)
Saves an image:
  • in a file in GIF format.
  • in memory.
gpwBiometricAuthentication (Function)
Enables biometric authentication for the connected user or retrieves the current status for the connected user.
Displaying a page in a WEBDEV website
Displaying a new page in a WEBDEV website can be done according to several methods...
<sfConnection variable>.Disconnect (Function)
Disconnects:
  • the Salesforce platform.
  • the current Salesforce session.
LogDirectory (Property)
The LogDirectory property is used to manage the directory of the log file described in the database schema.
spIterationCount (Property)
The spIterationCount property is used to:
  • Get the iteration count of the hash algorithm used for an item of type "Password". This property can be used for items of type "Password" defined in the data model editor or programmatically.
  • Sets the iteration count of the hash algorithm used for an item of type "Password" (only for "Password" items described programmatically).
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.
Trace (Function)
Displays the requested information (content of a control, for example) in a window opened next to the current window.
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...
MatchRegularExpression (Function)
Checks whether a character string matches a specific format and retrieves the different substrings that match the format.
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.
Animating the image display (WEBDEV)
The Web sites propose several transition effects between the elements:
Secure REST web service
WINDEV and WEBDEV allow you to create REST web services and secure access with OAuth tokens...
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.
EmailSeekFirst (Function)
Finds one or more emails according to the criteria specified in the messaging software (Outlook, messaging software using the IMAP protocol, ...).
2. WEBDEV administrator in practice
Builds a sequence of characters containing a line.
Pascal string of (Variable type)
The Pascal string of type corresponds to a length-prefixed string (this length is stored as a byte value). This type of variable is kept for backward compatibility.
WEBDEV administrator: Advanced configuration
The "Advanced" tab enables you to configure advanced options of the server...
pdfAttachment (Variable type)
The pdfAttachment type is used to define all the advanced characteristics of an attachment in a PDF document.
5. User Groupware in practice
Closes the current browser window and stops the execution of the current code.
nWDInitProject: Project initialization code
Run the project initialization code...
PicSave (Function)
Saves the image found:
  • in an Image Editor control.
  • in a WDPic variable.
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...
AnimationGetParameter (Function)
Reads the value of one of the animation parameters defined for an Image or Static Text control.
<Source>.EndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
Deploying an Android application
WINDEV Mobile Tutorial: Deploying an Android application 10 min
WINDEV 2026 Update
Here are the new features and improvements that you will discover in this version...
StartDatePeriodDisplayed (Property)
The StartDatePeriodDisplayed property gets the start date of the range displayed in a Scheduler or Organizer control of a report.
TestCheckNull (Function)
Checks whether an expression is Null in assertive programming and in automated test mode.
BTOpenDeviceProperties (Function)
Opens the window of properties for a Bluetooth device.
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.
<Image>AnimationGetParameter (Function)
Reads the value of one of the animation parameters defined for an Image field.
<Tab>.Open (Function)
Opens a new pane in a Dynamic Tab control.
Manipulating Word Processing controls programmatically
Word Processing controls can be manipulated programmatically...
WiFiSelectNetworkCard (Function)
Selects the Wi-Fi network card that will be used for the next calls to the WiFi functions.
<Buffer>.AnsiToUnicode (Function)
Converts a buffer containing an ANSI string (Windows) to a buffer containing a UNICODE string.
<PolygonGeo variable>.Intersect (Function)
Checks whether the intersection of a geographic polygon and another geometry does not result in an empty set.
Parameters of the procedure used by the ProximityShareAttendConnection function (Notification)
WLanguage procedure (also called "callback") called by the ShareProximityAttendConnection function to notify the connection status with a remote device.t
External components for different platforms
Components are a remarkably useful tool for development teams...
fMemOpen (Function)
Opens a memory area shared between several applications.
The Sidebar control
The Sidebar control gives access to different options...
xmlSignatureVerification (Variable type)
The xmlSignatureVerification type is used to define the information required to verify an XML signature.
<emailSMTPSession variable>.StartSession (Function)
Starts an SMTP session.
Deploying an Android application
WINDEV Mobile allows you to develop Android applications. Then, these applications can be easily deployed.
Using objects
To access a class, the object must be declared as being part of the class to handle, this is called object instantiation...
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.
Manipulating PDF files
PDF is one of the most widely used formats for sending and storing electronic documents...
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 Dockable Panel control
The Dockable Panel control allows you to easily organize the software interface into zones that the end user can freely move...
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.
Using Unicode in HFSQL tables
The database schema proposes two types of Unicode items ...
ReplicDeleteSubscription (Function)
Deletes the subscription of a replication on the replication server.
<PDF Reader>.Open (Function)
Opens a PDF file displayed in a PDF Reader control.
Operations performed on sequence diagrams
The following paragraphs explain...
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...
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...
NotesOpenDatabase (Function)
Gives access to the documents managed by Lotus Notes.
GPSInitParameter (Function)
Initializes the parameters of geolocation WLanguage functions and finds a location provider.
6. Printing the product catalog
WINDEV Mobile Tutorial - Developing an Android and iOS application Lesson 6 - Printing the product catalog - 20 min
fDecrypt (Function)
Decrypts a file that was encrypted by fCrypt.
1. Components provided with WINDEV
WINDEV is provided with projects that contain components.
docElement (Variable type)
The docElement type is used to handle each element found in a docParagraph variable.
DeclareWebserviceContext (Function)
Used to declare a list of variables whose value will be persistent between the successive calls to a web service.
<DiskFile variable>.Create (Function)
Creates an external file.
LDAPListAttribute (Function)
Lists the object attributes in an LDAP server.
NotesNbAttachment (Function)
Returns the number of files attached to an item of the current document in Lotus Notes.
Scheduler control: Customize appointments
In the Scheduler control, the appointment is displayed in a specific area...
Looper controls populated programmatically: Operations in WLanguage
Here is an overview of how to handle Looper controls populated programmatically in WLanguage.
zipOpen (Function)
Opens an existing archive.
Parameters of the procedure used by NearbyShareSend
WLanguage procedure ("callback") called by NearbyShareSend to notify whether or not the data was sent successfully.
FinNetCurrentVal (Function)
Returns the net current value of investment.
<Chrono>.Start (Function)
Starts a stopwatch to measure the duration of a process (in milliseconds) and resets a running stopwatch.
Address (Variable type)
The Address type is used to manipulate the address of a place or person.
Managing assertions
The main available features are as follows:
<Table>.ModifyLine (Function)
Modifies a row in:
  • a Table control,
  • a TreeView Table control.
1. Application overview
WINDEV Mobile tutorial: Developing an Android and iOS application Lesson 1 - Application overview - 10 min
The Tab control
The Tab control is used to simultaneously display different controls...
1
…
8