ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
CaptchaVerify (Function)
Checks whether the value typed by the user corresponds to the string displayed in a Captcha control.
Parameters of the procedure used by NearbyShareSend
WLanguage procedure ("callback") called by NearbyShareSend to notify whether or not the data was sent successfully.
RibbonAdaptSize (Function)
Adapts the size of the controls found in a Ribbon control according to the size of their caption.
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).
EmailListFolder (Example)
Usage example of the EmailListFolder function
DocEndModification (Function)
Signals the end of the grouping of a set of operations into a single event (undo/redo management).
<Word Processing>.EndModification (Function)
Indicates the end of a series of actions performed in a Word Processing control in a single event ("undo/redo").
WiFiSelectNetworkCard (Function)
Selects the Wi-Fi network card that will be used for the next calls to the WiFi functions.
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.
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.
EmulateSimulator (Function)
Emulates the window of the mobile (Android/iOS) simulator.
<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.
<Source>.EndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
<Connection variable>.DeleteScheduling (Function)
Delete a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
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.
<upnpDevice variable>.GetMute (Function)
Retrieves the 'Mute' status of a UPnP device.
KanbanListIndex (Function)
Returns the index of a list in a Kanban control.
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").
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.
PanelDetach (Function)
Detaches a Dockable Panel control to transform it into a floating window.
MapItineraryDistance (Function)
Calculates the distance of an itinerary in a Map control.
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.
<Image variable>.DrawShadow (Function)
Adds a shadow effect on an image found in an Image variable.
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.
<Image>AnimationGetParameter (Function)
Reads the value of one of the animation parameters defined for an Image field.
gpwBiometricAuthentication (Function)
Enables biometric authentication for the connected user or retrieves the current status for the connected user.
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.
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.
<Window>.Restore (Function)
Displays a WINDEV window to its initial size.
LDAPListAttribute (Function)
Lists the object attributes in an LDAP server.
gglOverride (Variable type)
The gglOverride type is used to define information about event notification overrides.
SpreadsheetSelectWorksheet (Function)
Selects a worksheet (identified by its name) in a Spreadsheet control.
WDInst: Manipulating the files to install
By default, the files to install are...
Defining specific character sets in HFSQL tables
When an application displays or saves data in HFSQL tables, this data is typed in the current language...
Modifying the query content
The queries are used to easily select the records coming from one or more files, matching one or more selection criteria, ...
LDAPValidateModify (Function)
Validates the modification of an existing object in an LDAP server.
AnimationMinFPS (Function)
Configures the minimum number of images per second in order for the animations (transition effects) to be enabled in the controls.
DDEError (Function)
Returns the runtime status report of a DDE function.
<Image>.AnimationSetParameter (Function)
Changes one of the animation parameters used for a moving image (in an Image field).
UPNPModifyContrast (Function)
Modifies the contrast of a UPnP device.
GroupDelete (Function)
Deletes the current group of contacts from a Lotus Notes or Outlook address book.
Hasp (Function)
Interrogates an electronic HASP key (HASP-3, HASP-4, MemoHasp or NetHasp).
FlexColumnGap (Property)
The FlexColumnGap property gets and sets the size of the gutter that separates the columns of a Flexbox control.
MySQL Native Connector: Special features
The Native MySQL Connector (also called "Native MySQL Access") creates "InnoDB" tables to support locks and transactions on a MySQL database...
PanelActivate (Function)
Activates a panel when several panels are docked together.
BackgroundImagePrinted (Property)
The property ImageFondImprimé allows you to:
  • Determine if the background image of a report (form or other) should be printed.
  • Print (or not) the background image of a report.
WLanguage procedure called by zipAddFileList
WLanguage procedure ("Callback") used by zipAddFileList to manage the progress of files being added to the archive.
The Switch control
Switch controls (also called "Toggle controls") are now commonly used in interfaces...
TransparencyMode (Property)
The TransparencyMode property gets and sets the transparency mode of an image.
WinEdDo (Function)
Runs an action (defined programmatically) and enables Undo/Redo operations on this action.
eDefaultMemCurrency (Function)
Identifies or modifies the stored currency used by default.
VisualEffect (Property)
The VisualEffect property allows you to apply a visual effect on a control or group of controls in a window.
ClipboardHeight (Function)
Calculates the height of an image (in bitmap format) found in the clipboard.
OrgOccurrence (Function)
Returns the number of elements found in an Organization Chart control.
apDisableAction (Function)
Disables the execution of an action found in an action plan.
gpwOAuthParameters (Variable type)
The gpwOAuthParameters type allows you to define all the information needed for authentication to the User Groupware via an application that uses the OAuth 2.0 standard.
<PDF reader>.GetSignatureDate (Function)
Gets the date of one of the signatures of a PDF document.
HandleParentNext (Function)
Forces the parent of the next window to open.
VisibleOutsideWindow (Property)
The VisibleOutsideWindow property is used to:
  • determine if a button is visible even if its position (X,Y) is outside the border of the window (entirely or partially).
  • modify the visibility of an "off-window" button.
RTFSelection (Function)
Modifies or lists the attributes of the text currently selected in an RTF field (in a WINDEV window or report).
VisibleEndUser (Property)
The VisibleEndUser property is used to:
  • Find out whether an item is visible or not to the end users. This item was defined in the data model editor or programmatically.
  • Define whether an item must be visible or not to the end users (only for items defined programmatically).
HTMLEditorInsertTable (Function)
Inserts a table at the cursor position in an HTML Editor control.
xBase/FoxPro Native Access: Features and notes
This help page presents the specific features regarding the programming of Native xBase/FoxPro Access...
NoteSaveAll (Function)
Saves the repositionable notes of the current window in a file.
UPNPMediaPause (Function)
Pauses the reading of the current media on the UPnP device.
TaskDelete (Function)
Deletes the current task from the task list of a Lotus Notes or Outlook messaging.
MinZoom (Property)
The MinZoom property is used to get the minimum zoom value that can be used for the Camera control (for the camera in use).
WinAdaptSize (Function)
Adapts the window size to the content of controls.
fListDirectory (Example)
Usage example of the fListDirectory function
Functions for managing Organization Chart controls (prefix syntax)
Two categories of data files are managed...
grScatter3DDeleteAltitudeColor (Function)
Deletes the altitude colors specified by grScatter3DAltitudeColor.
CtDescribedUserName (Property)
The CtDescribedUserName property sets the username used to connect to a specific table via OLE DB.
docStyle (Variable type)
The docStyle type is used to define the advanced characteristics of a style belonging to a document, a paragraph or a document fragment.
H.NumRec (Variable)
Contains the number of the physical record loaded in memory (which means the number of the last record read).
Table
The "Table" keyword can correspond to...
mongoOperationUpdateAll (Variable type)
The mongoOperationUpdateAll type is used to define all the advanced characteristics of a document update operation that will be added to a bulk operations list. All the documents that match the selection filter will be updated.
<upnpDevice variable>.ModifyContrast (Function)
Modifies the contrast of a UPnP device.
XMLOpenReader (Function)
Creates a reader used to read an XML document without loading it in memory.
WEBDEV Account Manager
WEBDEV Account Manager allows you easily host websites developed with WEBDEV. This tool is mainly intended for webmasters and hosting providers
<mongoCollection variable>.ExecuteOperations (Function)
Performs MongoDB write operations in bulk. This allows you to avoid network latency issues you would encounter if you performed the operations individually.
Configuring the registry (dynamic WEBDEV websites)
When installing a WEBDEV website on a Windows server, the details regarding the site are automatically inserted into the registry, at the following entry...
HClearWorkingDir (Function)
Clears and destroys the temporary directory previously created when HServerWorkingDir was executed.
DomoClose (Function)
Closes the communication opened by DomoOpen.
BTEnableService (Function)
Enables a service provided by a Bluetooth device.
WLanguage procedure called by inAppCheckSubscription
Procedure ("Callback") called by inAppCheckSubscription if one of the subscriptions has been renewed.
<HTML editor>.ToPDF (Function)
Exports the content of an HTML Editor control to a PDF file.
BTInfoRadio (Function)
Returns specific information about a Bluetooth radio connected to the computer.
tapiHold (Function)
Puts a call on hold.
mongoOperationDeleteOne (Variable type)
The mongoOperationDeleteOne type is used to define all the advanced characteristics of a document delete operation that will be added to a bulk operations list. The first document that matches the filter will be deleted.
MDIActive (Function)
Identifies or displays an MDI child window in the foreground.
ImageInfoClose (Function)
Closes the image file (in JPEG or TIFF format) used by ImageInfoValue and/or ImageInfoList and frees the image from memory.
StreamAccept (Function)
Associates a stream connection request with a Conference control.
BrightnessAuto
The BrightnessAuto keyword allows you to adjust brightness on an Android or iOS device.
WinRateDDW (Function)
Gets and sets the dimming rate for windows that use the DDW (Dim Disabled Windows) feature.
BackgroundTaskDelete (Function)
Deletes a background task (that was added by BackgroundTaskAdd).
BitcoinCoreDateTimeLatestBlock (Function)
Returns the date and time when the latest block was created.
<Connection variable>.AddScheduling (Function)
Adds a scheduled operation on an HFSQL server. This operation can be a scheduled task (stored procedure), backup, optimization or a materialized view refresh.
HDBIndex (Function)
Opens an xBase index file.
ControlFindTextPrevious (Function)
Searches for and selects the previous element corresponding to the text searched for in a window or field.
InterpretAmpersand (Property)
The InterpretAmpersand property is used to determine and change how the '&' character is interpreted in:
  • field label Window label.
  • the elements of a List Box control.
  • the elements of a Combo Box control.
  • the values of a column in a Table control.
Remote Control: Customizing with your own window
To customize the remote control performed on a multi-user WINDEV application, the standard window can be replaced with a window from your application...
<htmlNode variable>.RemoveAttribute (Function)
Removes a given attribute
CaptionPeriodHeader (Property)
The CaptionPeriodHeader property gets and sets the caption of the time period displayed in the header of a Scheduler or Agenda control in a report.
fStopCompress (Function)
Stops the operation used to compress or decompress a file.
Deploying an action plan
Once created, the action plans must be deployed in order to be run.
8. Smart controls
Defines the number of rows and columns in a Waffle chart.
HTMLEndPage (Property)
The HTMLEndPage property gets and sets the HTML code inserted at the end of the page.
HModifyItemRights (Function)
Modifies the rights granted to a user or group on an item of an HFSQL Client/Server table.
LDAPAddAttribute (Function)
Adds an attribute or adds a new value to an existing attribute.
AAFImportParameter (Function)
Loads all customizations made via AAFs (Automatic Applications Features) that have previously been saved to a file.
Managing the SNMP protocol
SNMP (Simple Network Management Protocol) is the standard protocol for managing the network devices...
MemcachedAddPrefix (Function)
Adds a value at the start of existing value in the cache for the given key.
Control Center of WINDEV executables (WDADMINEXE)
When a WINDEV application is installed in network, a program used to remotely check the application executables is automatically created...
HTTPCertificate (Function)
Modifies the client certificate used by default to identify oneself on a server.
<Map>.LimitArea (Function)
Limits the geographic area displayed in the Map control.
WLanguage procedure called by PVTCalculateAllAsynchronous
WLanguage procedure ("callback") called by PVTCalculateAllAsynchronous once all the data of a Pivot Table control has been calculated.
grScatter3DMarkCaption (Function)
Specifies the label of a mark in a 3D Scatter chart.
HTMLClassAdd (Function)
Adds a class into the HTML classes of a control.
BurnerCancel (Function)
Cancels the current burn process.
<Spreadsheet>.BorderSelection (Function)
Modifies the border of selected cells in a Spreadsheet control found in a window.
NoteDelete (Function)
Deletes a repositionable note found in the current window.
NetworkDirName (Function)
Identifies the shared directory associated with a network drive.
DocUpdateTableOfContents (Function)
Updates the table of the contents of a document.
WLanguage procedure called by zipAddFile
WLanguage procedure ("Callback") used by zipAddFile to manage the progress of files being added to the archive.
SpreadsheetSavePositionAndSelection (Function)
Saves:
  • the scrollbar position in a Spreadsheet control for the current worksheet,
  • the current worksheet in the Spreadsheet control,
  • the selected elements in the Spreadsheet control for the current worksheet.
<PDF reader>.AddWatermark (Function)
Adds a watermark to all the pages of a PDF file in a PDF Reader control.
<Looper>.StartFilling (Function)
Starts the process to populate a Looper control programmatically.
iTransparentMagenta (Function)
Modifies the management mode of Magenta color in order for this color to be considered as being transparent (or not) in all the forthcoming prints.
COMCreateInstance (Function)
Instantiates a COM object (Component Object Model).
Hash functions
Hashing is used to summarize a file or a character string...
<upnpDevice variable>.MediaPause (Function)
Pauses the reading of the current media on the UPnP device.
FaxCompleteStatus Structure
The FaxCompleteStatus structure is automatically filled during the call to FaxStatus...
5. HFSQL Client/Server
A WINDEV Mobile application can also use an HFSQL database in Client/Server mode.
Kanban control functions (prefix syntax)
The following functions manipulate Kanban controls...
<Camera>.SetDriver (Function)
Connects the "Camera" control to a specific driver for video capture.
Self-contained executable
The executable will be stand-alone if the following elements are included in the executable...
WindowBitmap (Function)
Creates the image of the specified window in a BMP file.
<Spreadsheet>.AddWorksheet (Function)
Adds a worksheet into a Spreadsheet control found in a window.
<emailNotesSession variable>.CloseSession (Function)
Closes a Notes session.
MemcachedAddPrefixKeyGroup (Function)
Adds a value at the start of existing value in the cache for the given key on a group of servers.
<Table>.FormulaDeleteAll (Function)
Deletes all rows added with <Table>.FormulaAdd.
Creating your own User Macro-Codes
The User Macro-Codes are sections of WLanguage code allowing the end user to customize his application...
SpreadsheetDeleteAll (Function)
Deletes the entire data from a Spreadsheet control found in a window (cells, formulas, size and header layouts).
AuthIntrospectToken (Function)
Determines the set of metadata for an OAuth token.
Controlling the WEBDEV Application Server
Starting with version 28, you can remotely control the WEBDEV Application Server...
sInExitQueue (Function)
Retrieves the number of bytes waiting to be transferred in the output buffer of the specified serial port or parallel port.
docRow (Variable type)
The docRow type is used to define the advanced characteristics of a table row in a Word Processing document.
DynamicTab (Property)
The DynamicTab property is used to:
  • Find out the type of a Tab control (static tab or dynamic tab).
  • Modify the type of a Tab control (static tab or dynamic tab).
hbColumnDescription (Variable type)
The hbColumnDescription type is used to define the advanced characteristics of a group of columns (items).
UPNPGetSharpness (Function)
Retrieves the sharpness of a UPnP device.
ShapeExtremityEnd (Property)
The ShapeExtremityEnd property is used to identify and change the type of shape used for the end of a Wire control.
Functions for managing Table controls (prefix syntax)
List of functions for managing Table controls (prefix syntax)
InvalidInputShowMessage (Function)
Displays an invalid input error for the specified control.
dbgEndRecording (Function)
Stops recording the scenario.
fTempPath (Example)
Usage example of the fTempPath function
HDeleteScheduling (Function)
Delete a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
SpreadsheetFreeze (Function)
Used to freeze the display of a row or column in a Spreadsheet control.
DocRedo (Function)
Restores the last undone action on a Word Processing document.
ShapePolygon (Function)
Modifies the shape currently displayed in a Shape control to get a custom shape (by specifying the coordinates of polygon points).
MDIEnumChild (Function)
Returns the alias of the specified MDI child window.
ActionDo (Function)
Creates and runs a custom action (defined through programming) with support of "Undo/Redo".
JSProperty (Function)
Used to handle specific features on the objects found in the current page.
WinEdUndo (Function)
Undoes the last action performed by the end user when modifying the interface ("Allow end users to modify the UI" option enabled).
Functions for managing Scheduler controls (prefix syntax)
List of functions that can be used with a Scheduler control (prefix syntax).
HTMLRemove (Function)
Removes the specified node and its descendants in an HTML document.
GglAccountDissociate (Function)
Dissociates the application from the user's Google account. This association must have been previously defined with GglAccountAssociate.
PythonTerminate (Function)
Unloads the Python DLL and frees memory.
HLogStop (Function)
Stops the log process of a file.
WLanguage procedure called by AppControl
Procedure ("Callback") called by AppliContrôle to process the remote control messages. This procedure can be a local, global or internal procedure.
CompactToolbar (Property)
The CompactToolbar property is used to:
  • determine if the window toolbars are compacted.
  • compact (or not) the toolbars.
LogFile (Property)
The LogFile property is used to determine if a table is a log file.
CameraChangeDriver (Function)
Connects the "Camera" control to a specific driver for video capture.
DisplayedItemImage (Property)
The DisplayedItemImage property is used to:
  • Get the item that corresponds to the image displayed in a ListView control.
  • Change the item that corresponds to the image displayed in a ListView control.
<Source>.DataSourceKnown (Function)
Determines if a data source has been initialized.
<Code Editor>.Execute (Function)
Executes the WLanguage code displayed in the Code Editor control.
InternalPagePopup (Property)
The InternalPagePopup property is used to get and modify the name of the internal page used to customize the content of marker popups in a Map control.
CursorCapture (Function)
Directs all the events associated with the mouse toward a specific window or control, regardless of the screen object where the mouse event occurs.
Permission (Variable type)
The Permission type represents a permission requested by the application (and therefore declared in the manifest).
Behavior changes between versions 2024 and 2025
WINDEV, WEBDEV and WINDEV Mobile allow you to manipulate an Image control through programming...
<emailOutlookSession variable>.CurrentFolder (Function)
Returns the name of the current folder in the Outlook messaging software.
inAppListProductInfo (Function)
Retrieves, from the store, information about the "In-App" products associated with the application.
<Captcha>.Display (Function)
Displays a new Captcha in a Captcha control.
fDriveReady (Function)
Determines:
  • if a given drive (storage card, CD or DVD) is available,
  • whether the drive exists.
SNMPOIDDescription (Function)
Returns the description of an OID.
fDateTime (Example)
Usage example of the fDateTime function
HTMLEditorToPDF (Function)
Exports the content of an HTML Editor control to a PDF file.
FaxDelete (Function)
Deletes a fax from the spooler and cancels it.
WebSocketSend (Function)
Sends a message from the WebSocket server to the client.
GroupModify (Function)
Modifies the current group of contacts in a Lotus Notes or Outlook address book.
<Diagram variable>.Save (Function)
Saves a diagram as a "diag" file.
HCreation (Example)
Example of the HCreation function
fReadLine (Example)
Usage example of the fReadLine function
1
2
3
4
5
6
…
9
>