ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
grGridlines (Function)
Displays or hides the chart gridlines.
CameraListDriver (Function)
Lists the video capture drivers installed on the current computer.
ChronoValue (Function)
Indicates the time elapsed (in milliseconds) since the call to ChronoStart.
iInfoPrinter (Function)
Retrieves the characteristics of the current or default printer.
XMLDocument (Example)
Usage example of the XMLDocument function
zipIsMulti (Function)
Returns the type of the archive: single-part archive or multi-part archive.
fSeek (Example)
Usage example of the fSeek function
NetGetFile (Example)
Usage example of the NetGetFile function
iParameterPreview (Function)
Configures the print preview:
  • display a message regarding the resources of current computer.
  • display or hide the ribbon tabs and buttons.
  • the export options available in the mini preview window.
gglEmail (Variable type)
The gglEmail type is used to describe and modify the email address of a contact...
RequestRefreshUIParent
Asks to run the "Request for refreshing the display" process of parent.
grSurfaceGetData (Function)
Retrieves a data from a Surface chart.
RequestRefreshUIElement (Function)
Requests the execution of the "Request for refreshing the display" event of the specified element (and gives back control without waiting for the execution of the event).
<Element>.RequestRefreshUI (Function)
Requests the execution of the "Request for refreshing the display" event of the specified element (and gives back control without waiting for the execution of the event).
ImageStartScrolling (Function)
Starts cycling through images.
<Chart>.SurfaceGetData (Function)
Retrieves a data from a Surface chart.
SysTheme (Function)
Returns the current theme of the device.
HourglassNetwork (Function)
Shows or hides an infinite progress bar in the title bar of Android application windows.
This function is no longer available from version 2024.
hbResultScan (Variable type)
The hbScanResult type is used to define all the advanced characteristics of the result of an iteration performed in an HBase database.
Elements of a class: Enumerate and manipulate programmatically
Several types of WLanguage variables are used to enumerate and dynamically handle the elements of a class...
<HTML Display control>.ExecuteJS (Function)
Runs JavaScript code in the context of the Web page displayed by an HTML Display control.
<Image>.StartScrolling (Function)
Starts cycling through images.
ContinentGet (Function)
Returns the Continent variable that corresponds to one of the following values:
  • a continent constant (2-character continent code),
  • a continent caption.
TwainScanArea (Function)
Used to define or reinitialize the area to scan.
hbColumn (Variable type)
The hbColumn type is used to define the advanced characteristics of a column (item) in an HBase table.
GglAddressToCoordinates (Function)
Retrieves the coordinates (latitude/longitude) of an address.
The structure of the file for remote control
The management of remote control uses a file in INI format...
hbReading (Variable type)
The hbReading type is used to define the characteristics of a read operation.
DateTimeDifference (Function)
Calculates the difference between two dates and times.
fWrite (Example)
Usage example of the fWrite function
<Source>.Reset (Function)
Initializes:
  • one or all variables of file items with their default values.
  • one or all items of a Record variable with their default values.
hbConnection (Variable type)
The hbConnection type is used to define the characteristics of a connection to an HBase server.
SMSFirst (Function)
Reads the first SMS message stored on the Android phone.
RequestRefreshUI
Requests the execution of the "Request for refreshing the display" event (and gives back control without waiting for the execution of the event).
CameraStop (Function)
Stops the video preview or video recording in a Camera control.
AndroidiPhone/iPad Function kept for "Version-26-compatible" Camera controls.
zipOpenCAB (Function)
Opens an existing archive in CAB format.
GenerateLorem (Function)
Generates a random "Lorem ipsum" text to temporarily populate a control with text, for example.
ScanWithUserInterface (Function)
Saves a document from a scanner to one or more files, using the scanner's user interface.
RequestUpdateUI (Function)
Requests the execution of the "Request for refreshing the display" event (and gives back control without waiting for the execution of the event). This function is kept for backward compatibility.
HourGlass (Function)
Transforms the mouse cursor into hourglass and vice versa.
In Android and iOS, displays an endless progress bar in a window.
HDBOpen (Function)
Opens the xBase data file and the "memo" file if it exists.
ExeListDLL (Function)
Returns the list of libraries (".DLL" files) used by one of the applications currently run.
fDateTime (Example)
Usage example of the fDateTime function
ImageMode (Property)
The ImageMode property gets and sets the display mode of an image in an Image control, in the column of a table of type Image or in the background of a Chart control in a window.
BankHolidayList (Function)
Returns the list of the public holidays defined by BankHolidayAdd.
<Scanner variable>.WithUserInterface (Function)
Saves a document from a scanner to one or more files, using the scanner's user interface.
DisplayEnabled (Property)
The DisplayEnabled property is used to:
  • determine whether or not a control or window is refreshed. If the control is displayed, its content is refreshed regularly.
  • refresh a control or window.
Continent (Variable type)
The Continent type is used to find out the characteristics of a continent.
SMSNext (Function)
Reads the following SMS message stored on the Android phone.
LooperRefreshVisible (Function)
Changes or returns the visibility status of the refresh bar in a Looper control.
SysIconDisplayTooltip (Function)
Displays a tooltip for an icon found in the taskbar.
WinRefreshVisible (Function)
Modifies or returns the visibility state of the refresh bar in a window.
xmlDocument (Variable type)
The xmlDocument type is used to handle an XML file.
SQLConnect (Example)
Usage example of the SQLConnect function
Creating the Form pages of a WEBDEV RAD pattern
VideoListDriver (Function)
Lists the video capture drivers installed on the current computer.
grGetData (Function)
Retrieves a data from a chart.
<Chart>.GetData (Function)
Retrieves a data from a chart.
iGroupAdd (Function)
Adds a report to a group of reports.
SecurityHtml (Property)
The SecurityHtml property gets and sets the status of the security mechanism of HTML Display and HTML Editor controls.
Defining colors in Table controls
The colors of a Table control (row background, text of rows, etc.) are defined in the control description...
BTIsVisible (Function)
Used to find out whether a Bluetooth radio is visible.
<zipArchive variable>.Exist (Function)
Determines whether an archive exists.
docNumbering (Variable type)
The docNumbering type is used to define the advanced characteristics of a numbering used in a Word Processing document.
BrowserHistoryModify (Function)
Modifies the data of current entry in the navigation history. This data will be transmitted when going back to the current entry.
<zipArchive variable>.IsMulti (Function)
Returns the type of the archive: single-part archive or multi-part archive.
zipMsgError (Function)
Returns the message associated with an error code on an archive.
zipExist (Function)
Determines whether an archive exists.
TableRefreshVisible (Function)
Modifies or returns the visibility status of refresh bar in a Table or TreeView Table control.
J2EERun (Function)
Runs a procedure on a server of J2EE XML web services.
WLanguage procedure called by zipAddDirectory
WLanguage procedure ("Callback") called when adding files with zipAddDirectory.
hbGetTableDescription (Function)
Retrieves the description of an HBase table.
HReset (Function)
Initializes:
  • one or all variables of file items with their default values.
  • one or all items of a Record variable with their default values.
<WLanguageCodeFormatting>.Format (Function)
Formats WLanguage code: coloring, normalized rewriting, indentation, translation.
<EmailPOP3Session variable>.GetAll (Function)
Retrieves all the emails found on a POP3 server.
WLanguageCodeFormat (Function)
Formats WLanguage code: coloring, normalized rewriting, indentation, translation, etc.
Print report (iPhone/iPad or Android)
When creating a report, the test of this report can be run from the report editor...
fDirSize (Function)
Returns the size of a directory in bytes.
EmailProgressBar (Function)
Manages a progress bar while sending and receiving emails.
zipOpen (Function)
Opens an existing archive.
J2EEGetResult (Function)
Returns the result of the last J2EE procedure that was successfully run.
<HTML Display control>.ExecuteBrowserProcedure (Function)
Executes a WLanguage browser procedure in an HTML Display control that displays a page created with WEBDEV.
ExecuteRefreshUI
Immediately executes the "Request for refreshing the display" event of the window, page, internal window, internal page, control template or supercontrol.
Managing contacts (mobile devices)
In your mobile applications, you can directly manage the contacts on your mobile device (Android, iPhone, iPad, etc.).
zipArchivedFile (Variable type)
The zipArchivedFile type is used to handle:
  • a file contained in an archive corresponding to one of the following formats: ZIP, CAB, RAR, WDZ, 7z, TAR, gzip or TGZ (TAR.GZ).
  • a file to add into an archive.
The planes (in a window or in a report)
The planes are used to group the window controls...
<HTML Display control>.ValidateForm (Function)
Validates a form in an HTML page displayed in an HTML Display control.
Example for managing videos (broadcasted by a Camera control)
In this example, the application allows you to...
Example of video management (transmitted by a Camera control) (prefix syntax)
In this example, the application allows you to...
PageNumber (Property)
The PageNumber property is used to:
  • get and change the number of the page displayed in an Image control ("multi-page" image files)
  • get and change the page number of a PDF file displayed in an Image control of a window
  • get and change the page number of a PDF file displayed in the background of a report.
<Element>.ExecuteRefreshUI (Function)
Immediately executes the "Request for refreshing the display" event of the given element.
ExecuteRefreshUIElement (Function)
Immediately executes the "Request for refreshing the display" event of the given element.
picRTF (Variable type)
The picRTF type is used to define all the advanced characteristics of a layer that contains RTF.
<EmailNotesSession variable>.GetAll (Function)
Retrieves all the emails found on a Notes server.
picText (Variable type)
The picText type is used to define all the advanced characteristics of a Text layer.
hbScanParameter (Variable type)
The hbScanParameter type is used to define the parameters for iterating over the records in an HBase database.
ExecuteUpdateUI (Function)
Immediately executes the "Request for refreshing the display" event of the window, page, internal window, internal page, control template or supercontrol. This function is kept for backward compatibility.
Automatic management of exceptions
The management of exceptions can be customized by process...
<EmailOutlookSession variable>.GetAll (Function)
Retrieves all the emails found on an Outlook server.
fSelect (Example)
Usage example of the fSelect function
iParameterPDF (Function)
Defines the options for the generated PDF file.
ExecuteRefreshUIParent
Immediately executes the "Request for refreshing the display" event of the parent.
<Table>.DeleteSelect (Function)
Deletes the selected rows from a Table or Treeview Table control.
iPrintWord (Function)
Sends the character string passed in parameter to the print buffer.
<Chart>.Tooltip (Function)
Displays and formats:
  • the tooltip associated with each section of a chart (section of a Pie chart, column of a Column chart, etc.). This function also gets the characteristics of the tooltip associated with each section of the chart.
  • a custom tooltip, associated with a point.
grTooltip (Function)
Displays and formats:
  • the tooltip associated with each section of a chart (section of a Pie chart, column of a Column chart, etc.). This function also gets the characteristics of the tooltip associated with each section of the chart.
  • a custom tooltip, associated with a point.
<zipArchive variable>.ListFile (Function)
Returns the list of files found in an archive.
ChangeCharset (Function)
Retrieves and/or changes the character set used:
  • by all the screen fonts.
  • by all the operations performed on the character strings (functions and/or operators).
Display (Property)
The Display property gets and sets the video displayed in the Conference control. The Conference control can display an incoming video, an outgoing video, or no video.
Playing a video with the MCI functions
MCI functions are used to easily handle the media files...
iPrintReport (Function)
Prints a report created with the report editor.
TableDeleteSelect (Function)
Deletes the selected rows from a Table or Treeview Table control.
zipCurrentFile (Function)
Returns the name of the archived file currently handled by the functions for adding and extracting files.
DisplayCurrency (Property)
The DisplayCurrency property gets and sets the currency used when entering or displaying values in a "Currency + Euro" control.
VideoStop (Function)
Stops the video preview or video recording in a Camera control.
AndroidiPhone/iPad Function kept for "Version-26-compatible" Camera controls.
zipOpenRAR (Function)
Opens an existing archive in RAR format.
<Table>.RefreshVisible (Function)
Modifies or returns the visibility status of refresh bar in a Table or TreeView Table control.
<Chart>.GridLines (Function)
Displays or hides the chart gridlines.
InWebMode (Function)
Indicates whether the current process is run:
  • from a WINDEV executable.
  • from the WEBDEV runtime engine (AWP).
<Camera>.Stop (Function)
Stops the video preview or video recording in a Camera control.
AndroidiPhone/iPad Function kept for "Version-26-compatible" Camera controls.
RequestUpdateUIParent (Function)
Asks to run the "Request for refreshing the display" process of parent. This function is kept for backward compatibility.
<zipArchive variable>.CurrentFile (Function)
Returns the name of the archived file currently handled by the functions for adding and extracting files.
<Looper>.RefreshVisible (Function)
Changes or returns the visibility status of the refresh bar in a Looper control.
Creating the Relation pages of a WEBDEV RAD pattern
ExecuteUpdateUIParent (Function)
Immediately executes the "Request for refreshing the display" event of the parent. This function is kept for backward compatibility.
<HTML Display control>.ControlValue (Function)
Used to identify or modify a control in an HTML form contained in an HTML Display control.
<zipArchive variable>.OpenRAR (Function)
Opens an existing archive in RAR format.
Events associated with Internal Page controls
List of events associated with internal pages and Internal Page controls
<Window>.Restore (Function)
Displays a WINDEV window to its initial size.
Detailed use of WINDEV FTP/RPC
External language: Programming in Fortran
We are going to call the elements developed in WINDEV (project, windows, analysis, ...
Image with automatic sequence (WEBDEV)
Image controls with automatic sequence are used to view a series of images located in one or more site directories. The images are automatically browsed.
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.
<Chart>.Parameter3DS (Function)
Retrieves or modifies a parameter for drawing a chart in 3D Spatial mode.
WLanguage procedure called by zipAddDirectory to handle the progress bar
WLanguage procedure ("Callback") used by zipAddDirectory to manage the progress of files being added to the archive.
Image with automatic scroll (WEBDEV) (prefix syntax)
Image controls with automatic sequence are used to view a series of images located in one or more site directories. The images are automatically browsed.
HTMLControlValue (Function)
Used to identify or modify a control in an HTML form contained in an HTML Display control.
gr3DSParameter (Function)
Retrieves or modifies a parameter for drawing a chart in 3D Spatial mode.
EnumSubElement (Function)
Used to enumerate the subelements of a project element.
Record (Variable type)
The Record type is used to save the values of a record.
<EmailIMAPSession>.GetAll (Function)
Retrieves all the emails found on an IMAP server.
Detecting Beacons
A "beacon" is a hardware transmitter that can "dialog" on a small perimeter with smartphones or tablets via a Bluetooth connection...
Creating the Form windows of a WINDEV RAD pattern
EmailGetAll (Function)
Retrieves all the emails found on a server.
Events associated with supercontrols
List of events associated with supercontrols
xmlNode (Variable type)
The xmlNode type is used to handle a node of an XML document.
Creating the Table pages of the WEBDEV RAD pattern
fTempPath (Example)
Usage example of the fTempPath function
<zipArchive variable>.InfoFile (Function)
Returns the characteristics of a file found an archive:
  • The name of the file and its stored path.
  • The initial size of the file.
  • The compressed size of file.
  • The date and time of file creation.
  • The date and time of file modification.
  • The date and time of file access.
  • The file attributes.
  • The file encryption mode.
<Table>.Sort (Function)
Sorts a Table or TreeView Table control on one or more columns (lexicographical sort).
docNumberingLevel (Variable type)
The docNumberingLevel type is used to define the advanced characteristics of a numbering level used in a Word Processing document.
zipInfoFile (Function)
Returns the characteristics of a file found an archive:
  • The name of the file and its stored path.
  • The initial size of the file.
  • The compressed size of file.
  • The date and time of file creation.
  • The date and time of file modification.
  • The date and time of file access.
  • The file attributes.
  • The file encryption mode.
BitmapInfo (Function)
Retrieves the characteristics of an image file or the characteristics of a PDF file:
  • format.
  • width and height.
  • number of bits per pixel.
  • area of transparency.
  • alpha channel.
BeaconDetectPrecise (Function)
Used to find the Beacons near the device.
Telephony: Managing incoming calls
The management of the incoming calls is performed in a specific "thread".
Currency + Euro type
In a WINDEV application or in a WEBDEV site, the Euro must be managed in all the controls used to enter or display currency values...
TableSort (Function)
Sorts a Table or TreeView Table control on one or more columns (lexicographical sort).
HTTPProgressBar (Function)
Displays a progress bar when:
  • receiving the response to an HTTP request.
  • sending an HTTP form (HTTPSendForm) or an HTTP query.
External language: Pascal programming
We are going to call the elements developed in WINDEV (project, windows, ...
Creating the Relation windows of a WINDEV RAD pattern
pdfParameter (Variable type)
The pdfParameter type defines all the characteristics of the PDF file to be generated.
<Window>.Maximize (Function)
Displays a WINDEV window in its maximum size.
WDModFic: Tool for automatic modification of data files
WDModFic is a tool for automated modification of data files on development and end-user workstations...
ExecutionMode (Function)
Allows you to:
  • find out and/or modify the behavior of the application or site when some errors are generated.
  • optimize the calls to the functions declared externally.
  • find out and/or change how the application uses JITc.
  • find out and/or modify the management mode of low references for all the instantiated objects.
hbListTable (Function)
Retrieves the list of tables found on an HBase server.
PanelActivate (Function)
Activates a panel when several panels are docked together.
<Dockable panel>.Activate (Function)
Activates a panel when several panels are docked together.
TimerSys (Function)
Periodically and automatically calls a WLanguage procedure.
RuleVisible (Property)
The RuleVisible property is used to:
  • Find out whether the rulers are visible or invisible in a Word Processing control.
  • Make the rulers visible or invisible in a Word Processing control.
Parameters of the procedure used by fReadLine
WLanguage procedure ("Callback") called by fReadLine for each line read in the file.
Indirection operators
Operators { and operators } operators are used to access a field, variable, class member or data file item by dynamically constructing the name of the field, variable, class member or item...
htmlNode (Variable type)
The htmlNode type is used to define all the advanced characteristics of a node of an HTML document.
LDAPMode (Function)
Modifies the operating mode of an LDAP session.
gglPostalAddress (Variable type)
The gglPostalAddress type is used to describe and modify the postal address of a contact...
zipAddDirectory (Function)
Adds all the files found in a directory and in its subdirectories into an archive and compresses them.
gglOrganization (Variable type)
The gglOrganization type is used to describe the companies and organizations to which a contact belongs...
hbRead (Function)
Reads cells (values of items) of a row (record) in an HBase table.
gglPhoneNumber (Variable type)
The gglPhoneNumber type is used to describe and modify the phone number of a contact...
gglInstantMessaging (Variable type)
The gglInstantMessaging type is used to describe and modify the characteristics of an instant messaging program used by a contact...
BurnerVolumeName (Function)
Allows you to find out or modify the name of the CD or DVD to burn.
ImageNext (Function)
Displays the next image for the scroll.
CDEject (Function)
Opens or closes the door of CD/DVD player selected on the current computer.
<Image>.Next (Function)
Displays the next image for the scroll.
Events associated with pages
List of events associated with pages
Events associated with internal windows
List of events associated with internal windows
<zipArchive variable>.OpenCAB (Function)
Opens an existing archive in CAB format.
<Chart>.TimeLevelMax (Function)
Defines the number of levels to display in the time scale of a chart as well as the maximum level.
grTimeLevelMax (Function)
Defines the number of levels to display in the time scale of a chart as well as the maximum level.
Managing parallel tasks
The computers are becoming more and more powerful...
BurnerEject (Function)
Opens or closes the door of the current burner.
Events associated with windows
List of events associated with windows
eDefaultViewCurrency (Function)
Identifies or modifies the display currency used by default.
iPrintPDF (Function)
Prints the content:
  • of a PDF file.
  • of a buffer containing a PDF.
  • of a PDF Reader control.
Managing emails with "Simple MAPI"
Simple MAPI simplifies the management of emails received by the hosting provider...
iParameter (Function)
Retrieves the printer configuration and configures the print.
<Source>.ExecuteSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the HFSQL engine.
HExecuteSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the HFSQL engine.
1
…
7
8