ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2025
NULL values: Allowing nullable types
Starting with version 2024, you can allow nullable types in a WINDEV, WEBDEV or WINDEV Mobile project...
Apply (Function)
Executes a procedure for each element of a WLanguage array.
HTMLEditorGet (Function)
Asynchronously retrieves the value of one of the properties of an HTML Editor control.
Value Description (Type of variable)
A Value Description variable is used to handle the description of an enumeration value through programming.
XMLData (Function)
Returns the value of current element (tag or XML attribute) or the value of one of its attributes.
LDAPStartModify (Function)
Initializes the modification of an existing object in an LDAP server.
DefaultValue (Property)
The DefaultValue property is used to:
  • Find out the default value of an item. This item was defined in the data model editor or programmatically.
  • Set the default value of an item (only for items defined programmatically).
Map (Function)
Executes a procedure on each element of a source array and returns the results in a WLanguage array.
<HTML editor>.Get (Function)
Asynchronously retrieves the value of one of the properties of an HTML Editor control.
<Source>.ErrorModification (Function)
Returns the value of a record item when a modification conflict occurs..
MemAdd (Function)
Adds an element to a memory area.
LDAPValidateModify (Function)
Validates the modification of an existing object in an LDAP server.
Display (External language)
Displays a value in a control or assigns a value in a variable.
MySelf (Reserved word)
MySelf is used to handle the current control...
HErrorModification (Function)
Allows you to:
  • return the value of a record item if a modification conflict occurs.
  • check if a modification conflict occurred.
The "Area" charts
The Area chart is used to highlight the amplitude of a change...
RegistryQueryValue (Function)
Reads a value in the Windows registry.
LDAPDeleteAttributeValue (Function)
Deletes a value of a specified attribute.
Value (Property)
The Value property gets and sets the value of an element.
<Document variable>.InsertTable (Function)
Inserts a table in a Document variable.
StoredValue (Property)
The StoredValue property is used to get the value currently stored by:
  • a row in a List Box, ListView or Combo Box control.
  • a "Text token" Edit control.
  • a row of a Table control.
  • an input suggestion in an Edit control (if the suggestion is selected).
<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.
FinCurrentVal (Function)
Returns the current value of investment.
FinDecreasingRedemption (Function)
Calculates the amortization value of a good over a specific period of time, via the formula for fixed-rate decreasing amortization.
DocInsert (Function)
Inserts an object into a Word Processing document or replaces the content of the current fragment. The objects that can be used are:
  • an element,
  • a document,
  • a paragraph,
  • a text,
  • an image,
  • a fragment.
gStoredValue (Function)
Adds an "invisible" value to an element in a List Box, Combo Box or Scheduler control.
AssistedInputAdd (Function)
Adds a row to the list of values available in the input suggestions of an Edit control.
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.
<Looper>.Modify (Function)
Changes the values of the attributes in a row of a Looper control.
Creating the Vision pages of the WEBDEV RAD pattern
ByReference (Property)
The ByReference property is used to determine if a procedure parameter was passed by reference.
ModbusDisconnect (Function)
Closes the Modbus session.
SWITCH statement
The SWITCH statement is used to choose the action that will be run according to the value of an expression...
hbReading (Variable type)
The hbReading type is used to define the characteristics of a read operation.
VisibleRange (Property)
The VisibleRange property gets and sets the width of the Range Slider control track.
SQLTransaction (Function)
Begins, commits or rolls back a transaction:
  • on the files of a database opened by SQLConnect,
  • on the files of a database opened by a connection (OLE DB or Native Access/Native Connector) described in the data model editor or by HOpenConnection.
gLink (Function)
Adds an "invisible" value to an element of a List or Combo Box control.
Function kept for compatibility. It is recommended to use gStoredValue.
<Word Processing>.InsertTable (Function)
Inserts a table into a Word Processing control.
The "Column" charts
The data is interpreted as "columns" whose height is proportional to the value of data...
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.
Unicode (Property)
The Unicode property is used to:
  • Determine if the value of a control is a Unicode string.
  • Specify whether the value of a control is a Unicode string.
mlzDelete (Function)
Deletes a dynamic row from a Multiline Zone control.
Manipulating Action Bars programmatically
Action Bars can be manipulated programmatically. To do so, use the variable corresponding to the Action Bar in the code.
Assignment of RETURN
The return value of the process currently run can be assigned...
hbColumn (Variable type)
The hbColumn type is used to define the advanced characteristics of a column (item) in an HBase table.
Bitwise operators
The operations on binary values are performed...
PopupDisplayPage (Function)
Displays a WEBDEV page as a popup in the current page with a DDW (Dim Disabled Windows) effect.
<Multiline Zone>.Delete (Function)
Deletes a dynamic row from a Multiline Zone control.
<Page>.DisplayPopup (Function)
Displays a WEBDEV page as a popup in the current page with a DDW (Dim Disabled Windows) effect.
WidgetRunApp (Function)
Starts the application to which a widget belongs.
SQLSeek (Function)
Positions on the specified result row of the query.
HHistoryModification (Function)
Returns the modifications performed on one or more items of a given record. The result can be displayed in a list box or in a table to allow the user to view the modifications made to the specified file.
MatFloatAdd (Function)
Adds a value to each matrix element.
Round (Function)
Returns the rounded value of a numeric value according to the specified number of decimal places.
FolderImageWidth (Property)
The FolderImageWidth property gets and sets the folder image width in TreeView and TreeView Table controls.
MariaDB Native Connector: Special features
The Native MariaDB Connector creates "InnoDB" tables to support locks and transactions on a MariaDB database...
Multiple assignments of arrays, structures and classes
The multiple assignment of arrays consists in assigning a set of simple values (boolean, integer, string, real, numeric or currency) to the cells of an array.
This multiple assignment is also available for the structures and the classes.
MatFloatMultiply (Function)
Multiplies each matrix element by a value.
Variant (Variable type)
The Variant type is used to:
  • store any value of simple type: Boolean, Numerical (Monetary, Real, Integer, ...), Character and String, Date (Date, Time, DateTime and Duration), ...
  • store named or indexed subelements.
  • store any complex type value: structures, classes, advanced types, arrays, associative arrays, queues, stacks and lists.
  • handle the NULL value in WLanguage.
  • store interactions with ActiveX objects and Automation programming.
SQLTransaction (Example)
Usage example of the SQLTransaction function
StreamDisconnect (Function)
Stops receiving or broadcasting a stream.
Edit control events
WLanguage events associated with Edit controls
LDAPReplaceAttributeValue (Function)
Replaces a specific value of an attribute by a new value.
StreamStop (Function)
Stops receiving or broadcasting a type of data in a stream.
Creating the Vision windows of the WINDEV RAD pattern
Creating the Form windows of a WINDEV RAD pattern
XamlProperty (Function)
Used to find out and modify the value of a .Net property for an Xaml control or for a Carousel control.
ByAddress (Property)
The ByAddress property is used to determine if a procedure parameter was passed by address.
NotesListItem (Function)
Returns the list of items for the current Notes document in Lotus Notes.
LDAPValue (Function)
Returns the value corresponding to the index passed as parameter for the specified attribute.
ModbusConnectTCP (Function)
Connects a client to a Modbus server via transmission control protocol (TCP).
modbusSession (Variable type)
The modbusSession type is used to identify a connection to a Modbus server.
<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.
DocInsertTable (Function)
Inserts a table into a Word Processing document.
TelemetryAddMeasure (Function)
Adds a measure for a value or time sensor.
<XAML>.Property (Function)
Allows you to find out and modify the value of a .Net property for an Xaml control or for a Carousel control.
ModbusConnectRTU (Function)
Connects a client to a Modbus slave via a serial port.
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...
MemLast (Function)
Sets the position on the last element of memory area and returns the value of this element.
NullSupported (Property)
The NullSupported property is used to manage the NULL value in HFSQL data files.
Null (Reserved word)
The Null keyword can be used according to different methods in WLanguage...
HSetReplication (Function)
Temporarily disables (or re-enables) the replication.
ScanProperty (Function)
Used to get and change the properties of a scanner.
Assignment operators
Three assignment operators are available...
LooperBreakIndex (Function)
Returns the index of the break header and footer for a given break in a Looper control.
gLinkActivate (Function)
Allows (or not) retrieving the value defined by gLink in a List Box or a Combo Box control.
Function kept for compatibility. It is recommended to use gStoredValueEnable.
DnDCacheData (Function)
Indicates the type of data and the data to copy/move during Drag/Drop.
JSEvent (Function)
Associates a browser procedure with an event on an object in browser code.
Creating the Relation windows of a WINDEV RAD pattern
grTimeLevelMask (Function)
Defines the display mask for a level of time scale in a chart.
<Chart>.TimeLevelMask (Function)
Defines the display mask for a level of time scale in a chart.
EmailStartPOP3Session (Function)
Starts a session for receiving and reading emails with the POP3 protocol.
Looper control linked to a data file
A Looper control can be used to display the content of a data file or query...
<Source>.FilterContains (Function)
Defines and enables a "Contains" filter on a data file, view or query.
BarCodes (Variable type)
The BarCodes type is used to handle the information found in a bar code.
DomoSend (Function)
Sends a command to one or more electrical devices compatible with the X10 protocol.
hbScanParameter (Variable type)
The hbScanParameter type is used to define the parameters for iterating over the records in an HBase database.
<Looper>.BreakIndex (Function)
Returns the index of the break header and footer for a given break in a Looper control.
<Scanner variable>.Property (Function)
Used to get and change the characteristics of a scanner.
<Source>.ToItem (Function)
Assigns the specified value to an item of the current record.
StatMax (Function)
Calculates the maximum value for a series of values.
StatMin (Function)
Calculates the minimum value for a series of values.
HToItem (Function)
Assigns the specified value to an item of the current record.
RegistrySetValue (Function)
Writes a value to a key in the Windows registry.
TableBreakIndex (Function)
Returns the index of the break header and footer for a given break in a Table control.
<Table>.BreakIndex (Function)
Returns the index of the break header and footer for a given break in a Table control.
HSaveParameter (Function)
Saves a persistent value on the HFSQL server.
MemSeek (Function)
Seeks an element in a memory area:
  • on the value added by MemAdd or on the value modified by MemModify,
  • on the return value.
SNMPGetNext (Function)
Reads the value found after the last value retrieved for an SNMP agent.
MyParent (Reserved word)
MyParent is used to handle...
MemPrevious (Function)
Positions on the element found before the current element of a memory area and returns the value of this element.
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...
FinNetCurrentVal (Function)
Returns the net current value of investment.
MemNext (Function)
Positions on the next element of a memory area and returns the value of this element.
Managing HBase databases
HBase is a non-relational (NoSQL) distributed database, based on columns and using non-structured storage for large tables...
MemFirst (Function)
Positions on the first element of a memory area and returns the value of this first element.
Window with parameters
A window can:
  • Receive parameters when it is opened.
  • Return values when it is closed.
JavaLoad (Function)
Specifies the location of user classes required to run the Java application or the Java applet.
RegistryValueType (Function)
Returns the type of value found in the registry.
Manipulating Internal Window controls programmatically
The "Internal Window" control is used to display an existing internal window...
RegistryRename (Function)
Renames a key in the registry.
Manipulating Word Processing controls programmatically (prefix syntax)
Word Processing controls can be manipulated programmatically...
ZOrder (Property)
The ZOrder property defines the Z-order of an element.
String literals: single-line and multiline strings
String literals are used to represent and manipulate data as a sequence of characters. For example, string literals can be used to display information, define a constant, etc.
ExecuteCode (Function)
Runs the WLanguage code found in a character string.
LDAPAddAttribute (Function)
Adds an attribute or adds a new value to an existing attribute.
HOnError (Example)
Usage example of the HOnError function
POUR TOUT / POUR ALL instruction (data file browsing)
Training FOR ALL instruction can be used to perform different types of runs...
<restRequest variable>.Send (Function)
Sends a REST request and waits for the server response.
<Word Processing>.Insert (Function)
Inserts an object in a Word Processing control. The objects that can be used are:
  • an element,
  • a document,
  • a paragraph,
  • a text,
  • an image,
  • a fragment.
Handling a dynamic programmatically
WINDEV allows you to manipulate Dynamic Tab controls with the TabXXX functions and with multiple WLanguage properties...
Handling a dynamic tab through programming (prefix syntax)
WINDEV allows you to manipulate Dynamic Tab controls with the TabXXX functions and with multiple WLanguage properties...
DisplayedValue (Property)
The DisplayedValue property returns the value currently displayed in the control of a window or page.
Associative array (Variable type)
An associative array is an "advanced" type of array...
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.
<Document variable>.Insert (Function)
Inserts an object in a Document variable. The objects that can be used are:
  • an element,
  • a document,
  • a paragraph,
  • a text,
  • an image,
  • a fragment.
wsResponse (Variable type)
The wsResponse type is used to get:
  • the XML source code of the web service response.
  • the value of the different parts of the web service response (for the web services returning several responses).
SelectColor (Function)
Opens the standard window for color selection and selects the specified color.
ImageInfoList (Function)
Returns the list of Exif tags available for the image used.
hbRead (Function)
Reads cells (values of items) of a row (record) in an HBase table.
Type inference
The type inference is used to simplify the declaration of variables when the variable type can be automatically deduced by the compiler...
Detailed use of WINDEV FTP/RPC
HFilterContains (Function)
Defines and enables a "Contains" filter on a data file, view or query.
FileToMemoryList (Function)
Populates a List Box or Combo Box control programmatically with the records from a data file or query.
EvaluateExpression (Function)
Evaluates the value of an expression built in a character string.
Manipulating Word Processing controls programmatically
Word Processing controls can be manipulated programmatically...
JSProperty (Function)
Used to handle specific features on the objects found in the current page.
WLanguage procedure called by PopupDisplayPage
WLanguage procedure ("callback") called by PopupDisplayPage after the popup page is closed.
Manager of automated tests
The test manager is used to...
aiImageResult (Variable type)
The aiImageResult type is used to retrieve the result of AIDetect.
<Chart>.AddData (Function)
Adds a data into a chart.
AIDetect (Function)
Detects various elements in an image: objects, faces, etc. This detection is made possible by artificial intelligence (AI).
grAddData (Function)
Adds a data into a chart.
SQLCol (Function)
Retrieves the content of the specified column from the query result, for the current line.
Describing the Action Bar control
This help page presents the main aspects of the Action Bar description window ...
General exception mechanism
A process of general exception is available for all the components of the object with which it is associated...
Custom telemetry
Custom telemetry allows you to define the elements that will be included in the analytics...
ImageInfoValue (Function)
Returns the value of an Exif tag for the image used.
Multiselection (Property)
The Multiselection property gets and sets the selection mode:
  • in a Table and TreeView Table control.
  • in a Pivot Table control.
  • in a List Box and ListView control.
  • in a Looper control.
  • in a Calendar control.
  • of files in an Upload control.
SQLGetCol (Function)
Retrieves the content of the specified column from the query result, for the current line.
ImageInfoModify (Function)
Modifies the value of an Exif tag for the image used.
TableSearch (Function)
Performs a search in:
  • a Table control,
  • a TreeView Table control,
  • tables displayed in a Combo Box control.
The HTML Editor control
The HTML Editor control allows users to create and modify HTML pages...
Referring to an element in a WLanguage event / process
Combination (Variable type)
A combination is a set of options.
Value (Property)
The Value property is used to:
  • Find out and modify the value of a report control.
  • Find out and modify the value of a control or the title of a window.
  • Find out the identifier of a stream.
  • Find out and modify the value of a control or the title of a page.
HSeekLast (Function)
Sets the position on the last file record whose value for a specific item is less than or equal to a sought value.
<Source>.SeekLast (Function)
Sets the position on the last file record whose value for a specific item is less than or equal to a sought value.
CookieRead (Example)
Usage example of the CookieRead function
Compilation instruction: COMPILE SI
The <COMPILE IF> statement allows you to compile (or not) a WLanguage code according to a condition.
CookieWrite (Example)
Usage example of the CookieWrite function
<Image>.AnimationSetParameter (Function)
Changes one of the animation parameters used for a moving image (in an Image field).
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...
CertificateExtractExtensionValue (Function)
Returns the value of a certificate extension.
<Certificate variable>.ExtractExtensionValue (Function)
Returns the value of a certificate extension.
MemcachedAssign (Function)
Modifies a key/value couple in the Memcached cache:
  • If the key exists, the value is modified.
  • If the key does not exist, the key/value couple is added.
NetworkDisconnect (Function)
Disconnects a network drive.
AssistedInput (Variable type)
The AssistedInput type allows you to define all the advanced characteristics of an autocomplete suggestion.
ValuePerStar (Property)
The ValuePerStar property gets and sets the value of a star in a Rating control.
HReadSeekLast (Function)
Sets the position on the last record whose value for a specific item is less than or equal to a sought value (exact-match search).
CameraParameter (Function)
Returns or modifies the value of a parameter for the device camera.
AndroidiPhone/iPad Function kept for "Version-26-compatible" Camera controls.
InputMask (Property)
The InputMask property is used to:
  • get the input mask.
  • set the input mask (from the masks available for the type).
VideoParameter (Function)
Returns or modifies the value of a parameter for the device camera.
AndroidiPhone/iPad Function kept for "Version-26-compatible" Camera controls.
EmulateDialog (Function)
Emulates the next call to Dialog and automatically clicks the button passed as parameter.
Characteristics of the columns in a Table control in a window (prefix syntax)
The columns are used to display information in a Table control...
<Chart>.TimeLevelMax (Function)
Defines the number of levels to display in the time scale of a chart as well as the maximum level.
Characteristics of the columns in a Table control in a window
The columns are used to display information in a Table control...
eExchangeRate (Function)
Returns the value of the exchange rate for a currency.
grTimeLevelMax (Function)
Defines the number of levels to display in the time scale of a chart as well as the maximum level.
LDAPReplaceAttribute (Function)
Replaces all the values of an attribute by a specific value.
RulerValue (Property)
The RulerValue property is used to get or change the position of the playhead in a TimeLine control.
Compile (Function)
Dynamically compile a Procedure whose source code is supplied (dynamic compilation).
Page with parameters
SQLExec (Function)
Names and runs an SQL query.
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.
Break in a Table control
A break in a Table control is used to group the data corresponding to one or more arguments...
iParameter (Function)
Retrieves the printer configuration and configures the print.
1
…
8