ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2025
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).
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.
MatReadLine (Function)
Reads the value of all elements found in a matrix row.
NULL values: Allowing nullable types
Starting with version 2024, you can allow nullable types in a WINDEV, WEBDEV or WINDEV Mobile project...
CancelWebserviceContext (Function)
Deletes from the web service context a variable added by DeclareWebserviceContext.
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..
LDAPStartModify (Function)
Initializes the modification of an existing object in an LDAP server.
HErrorModification (Function)
Allows you to:
  • return the value of a record item if a modification conflict occurs.
  • check if a modification conflict occurred.
LDAPValidateModify (Function)
Validates the modification of an existing object in an LDAP server.
FinLinearRedemption (Function)
Calculates the value of linear amortization of a product over a specific period of time.
Thumbnail (Property)
The property Thumbnail property allows you to:
  • get the value of an item thumbnail. This item was defined in the data model editor or programmatically.
  • get and change the image associated with a Thumbnail control.
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...
The "Area" charts
The Area chart is used to highlight the amplitude of a change...
MemAdd (Function)
Adds an element to a memory area.
RegistryQueryValue (Function)
Reads a value in the Windows registry.
LDAPDeleteAttributeValue (Function)
Deletes a value of a specified attribute.
<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.
<Document variable>.InsertTable (Function)
Inserts a table in a Document variable.
pvtPosition (Variable type)
The pvtPosition type can be used to manipulate a cell of a Pivot Table control.
WEBDEV - Server codeWEBDEV - Browser codeLinux This type of variable is a new feature available from WINDEV Suite SaaS 2025 Update 4.
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).
InitialValue (Property)
The property InitialValue property is used to find out the initial value of a window or page control.
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.
Value (Property)
The Value property gets and sets the value of an element.
gStoredValue (Function)
Adds an "invisible" value to an element in a List Box, Combo Box or Scheduler 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.
ByReference (Property)
The ByReference property is used to determine if a procedure parameter was passed by reference.
ModbusDisconnect (Function)
Closes the Modbus session.
DocInsertTable (Function)
Inserts a table into a Word Processing document.
DeclareWebserviceContext (Function)
Used to declare a list of variables whose value will be persistent between the successive calls to a web service.
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.
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.
WebserviceParameter (Function)
Gets the value of a parameter in a call to a SOAP or REST web service.
<Word Processing>.InsertTable (Function)
Inserts a table into a Word Processing control.
grScatterSeriesColor (Function)
Initializes the color of a series in a "Scatter" chart.
Android Warning: This feature is only available from WINDEV Suite SaaS 2025 Update 2.
For more details, see Utiliser les nouveautés de WINDEV Suite SaaS 2025.
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.
Manipulating PDF files
PDF is one of the most widely used formats for sending and storing electronic documents...
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.
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.
<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.
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.
<Source>.HistoryModification (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.
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.
MariaDB Native Connector: Special features
The Native MariaDB Connector creates "InnoDB" tables to support locks and transactions on a MariaDB database...
SQLTransaction (Example)
Usage example of the SQLTransaction function
SSL: Secure transactions with WEBDEV
When using an Internet application, the data circulating between the computer of the Web user and the Web server is not protected...
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.
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.
StreamDisconnect (Function)
Stops receiving or broadcasting a stream.
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.
XamlProperty (Function)
Used to find out and modify the value of a .Net property for an Xaml control or for a Carousel control.
hbReading (Variable type)
The hbReading type is used to define the characteristics of a read operation.
TelemetryAddMeasure (Function)
Adds a measure for a value or time sensor.
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.
LDAPValue (Function)
Returns the value corresponding to the index passed as parameter for the specified attribute.
<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...
Null (Reserved word)
The Null keyword can be used according to different methods in WLanguage...
WidgetRunApp (Function)
Starts the application to which a widget belongs.
HSetReplication (Function)
Temporarily disables (or re-enables) the replication.
<Looper>.BreakIndex (Function)
Returns the index of the break header and footer for a given break in a Looper control.
JavaLoad (Function)
Specifies the location of user classes required to run the Java application or the Java applet.
<Scanner variable>.Property (Function)
Used to get and change the characteristics of a scanner.
<Chart>.ScatterSeriesColor (Function)
Initializes the color of a series in a "Scatter" chart.
Android Warning: This feature is only available from WINDEV Suite SaaS 2025 Update 2.
For more details, see Utiliser les nouveautés de WINDEV Suite SaaS 2025.
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.
ScanProperty (Function)
Used to get and change the properties of a scanner.
DnDCacheData (Function)
Indicates the type of data and the data to copy/move during Drag/Drop.
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.
<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.
ExecuteCode (Function)
Runs the WLanguage code found in a character string.
Manipulating Word Processing controls programmatically (prefix syntax)
Word Processing controls can be manipulated programmatically...
JSEvent (Function)
Associates a browser procedure with an event on an object in browser code.
RegistryValueType (Function)
Returns the type of value found in the registry.
StatMin (Function)
Calculates the minimum value for a series of values.
StatMax (Function)
Calculates the maximum 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.
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.
NullSupported (Property)
The NullSupported property is used to manage the NULL value in HFSQL data files.
MemLast (Function)
Sets the position on the last element of memory area and returns the value of this element.
RegistryRename (Function)
Renames a key in the registry.
ShamirCreateShares (Function)
Creates a set of keys for the same secret using Shamir's algorithm.
This new feature is available as of WINDEV Suite SaaS 2025 Update 4.
Manipulating Word Processing controls programmatically
Word Processing controls can be manipulated programmatically...
EvaluateExpression (Function)
Evaluates the value of an expression built in a character string.
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.
hbScanParameter (Variable type)
The hbScanParameter type is used to define the parameters for iterating over the records in an HBase database.
JSProperty (Function)
Used to handle specific features on the objects found in the current page.
<restRequest variable>.Send (Function)
Sends a REST request and waits for the server response.
LDAPAddAttribute (Function)
Adds an attribute or adds a new value to an existing attribute.
HOnError (Example)
Usage example of the HOnError function
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...
<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...
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.
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...
ImageInfoList (Function)
Returns the list of Exif tags available for the image used.
<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).
Detailed use of WINDEV FTP/RPC
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...
HFilterContains (Function)
Defines and enables a "Contains" filter on a data file, view or query.
<Chart>.ScatterAddDataXY (Function)
Adds a data into a "Scatter" chart.
Android Warning: This feature is only available from WINDEV Suite SaaS 2025 Update 2.
For more details, see Utiliser les nouveautés de WINDEV Suite SaaS 2025.
FileToMemoryList (Function)
Populates a List Box or Combo Box control programmatically with the records from a data file or query.
ZOrder (Property)
The ZOrder property defines the Z-order of an element.
FinFutureVal (Function)
Returns the future value of an investment.
<Source>.ToItem (Function)
Assigns the specified value to an item of the current record.
WLanguage procedure called by PopupDisplayPage
WLanguage procedure ("callback") called by PopupDisplayPage after the popup page is closed.
grScatterAddDataXY (Function)
Adds a data into a "Scatter" chart.
Android Warning: This feature is only available from WINDEV Suite SaaS 2025 Update 2.
For more details, see Utiliser les nouveautés de WINDEV Suite SaaS 2025.
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.
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...
BackgroundColor (Property)
The BackgroundColor property is used to set the background color of a control, window, page or block of a report.
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.
Project description: Compilation tab
The project description window allows you to configure various elements of your project...
CookieRead (Example)
Usage example of the CookieRead function
Compilation statement: COMPILE IF
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).
SQL statements
The main SQL statements allowed in the SQL queries managed by WINDEV and WEBDEV are as follows...
CertificateExtractExtensionValue (Function)
Returns the value of a certificate extension.
<Certificate variable>.ExtractExtensionValue (Function)
Returns the value of a certificate extension.
Manipulating Pivot Table controls programmatically
A Pivot Table control can be handled through programming...
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.
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.
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...
RulerValue (Property)
The RulerValue property is used to get or change the position of the playhead in a TimeLine 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.
Characteristics of the columns in a Table control in a window (prefix syntax)
The columns are used to display information in a Table control...
Compile (Function)
Dynamically compile a Procedure whose source code is supplied (dynamic compilation).
SQLExec (Function)
Names and runs an SQL query.
OAuth server integrated into WEBDEV Application Server
The OAuth protocol is an open standard used to issue secure authorizations...
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.
Input (Function)
Displays a message allowing the user to type an information.
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
…
9