ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
dTransferToImage (Example)
Usage example of the dTransferToImage function
Parameters of the procedure used by NearbyShareSend
WLanguage procedure ("callback") called by NearbyShareSend to notify whether or not the data was sent successfully.
BTEnableService (Function)
Enables a service provided by a Bluetooth device.
Error 1009: The member of the class is private
Constants for managing the multi-touch
WLanguage procedure called by inAppCheckSubscription
Procedure ("Callback") called by inAppCheckSubscription if one of the subscriptions has been renewed.
zipNbPartNeeded (Example)
Usage example of the zipNbPartNeeded function
<AuthToken>.Revoke (Function)
Revokes a JSON Web Token (JWT).
SOAPError (Example)
Usage example of the SOAPError function
gglOverride (Variable type)
The gglOverride type is used to define information about event notification overrides.
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.
SOAPGetResult (Example)
Usage example of the SOAPGetResult function
XMLOpenReader (Function)
Creates a reader used to read an XML document without loading it in memory.
<htmlNode variable>.RemoveAttribute (Function)
Removes a given attribute
WLanguage procedure called by zipAddFileList
WLanguage procedure ("Callback") used by zipAddFileList to manage the progress of files being added to the archive.
MatFill (Example)
Usage example of the MatFill function
DriveDownloadGglFile (Function)
Downloads a Google Docs Editors file from Google Drive in a given compatible format.
HState (Example)
Usage example of the HState function
TabSaveConfiguration (Function)
Saves the configuration of dynamic tabs found in a Tab control in character string format.
HCreationIfNotFound (Example)
Example of the HCreationIfNotFound function
VideoGenerateThumbnail (Example)
Usage example of the VideoGenerateThumbnail function
EmailNbMessage (Example)
Usage example of the EmailNbMessage function
tapiNoAnswer (Function)
Used to find out whether an answer was given to the call.
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.
Error 30: An exception process cannot be declared inside another exception process...
Indicates whether the code is run in the iOS emulator (iPhone, iPad).
zipNbFile (Example)
Usage example of the zipNbFile function
grRealTimeInterval (Function)
Sets the time interval visible in a time chart with real-time display.
NotesOpenDatabase (Function)
Gives access to the documents managed by Lotus Notes.
HandleParentNext (Function)
Forces the parent of the next window to open.
<PDF reader>.GetSignatureDate (Function)
Gets the date of one of the signatures of a PDF document.
BitcoinCoreBlockCount (Function)
Returns the size of the blockchain known by the Bitcoin node (i.e. the number of blocks created since January 3, 2009). This makes it possible, for example, to calculate the approximate date of the next halving.
Parameters of the procedure used by the ProximityShareAttendConnection function (Notification)
WLanguage procedure (also called "callback") called by the ShareProximityAttendConnection function to notify the connection status with a remote device.t
<Drive variable>.Rename (Function)
Renames a file or directory on a remote drive.
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.
SysNotificationSend (Function)
Sends an interactive notification to the system in order to be displayed.
Error 107: Redefinition of the parameter
The Notification keyword can correspond to:
<upnpDevice variable>.GetMute (Function)
Retrieves the 'Mute' status of a UPnP device.
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.
Brazil.CheckCPF (Function)
Checks the validity of a CPF number (personal identification number in Brazil).
Parameters of the procedure used by NearbyShareRequestConnection (Notification)
Callback of the NearbyShareRequestConnection1.Cb function for the "CallbackConnection" parameter
xlsOpen (Example)
Usage example of the xlsOpen function
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").
SchedulerWorkingHourResource (Function)
Used to indicate the specific working hours per day and per resource in a Scheduler control.
KanbanListIndex (Function)
Returns the index of a list in a Kanban control.
PanelDetach (Function)
Detaches a Dockable Panel control to transform it into a floating window.
<Image>.Occurrence (Function)
Returns the total number of images taken into account by the scroll.
Error 530: The -- operator is not allowed
To simplify the reading in the controls used to view large volumes of data, the end user has the ability to zoom the data found in the control...
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.
<Connection variable>.NotifDeleteCCRecipient (Function)
Deletes the recipients of a notification sent via the Control Centers (WDBal messaging tool).
<Image>.First (Function)
Displays the first image for the scroll.
<Source>.EndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
<Window>.EdDo (Window)
Runs an action (defined programmatically) and enables Undo/Redo operations on this action.
<docFragment variable>.ClearFormatting (Function)
Replaces the current formatting of a selection with the default formatting.
<Window>.EdSelect (Function)
Returns one of the controls selected when the interface is modified by the end user ("Allow end users to modify the UI" option enabled).
TrustedCertificateReset (Function)
Removes all the certificates added by TrustedCertificateAdd.
ReplicDeleteSubscription (Function)
Deletes the subscription of a replication on the replication server.
xmlSignatureVerification (Variable type)
The xmlSignatureVerification type is used to define the information required to verify an XML signature.
WiFiSelectNetworkCard (Function)
Selects the Wi-Fi network card that will be used for the next calls to the WiFi functions.
BrowserShare (Function)
Starts the device's native share functionality.
<Code Editor>.Load (Function)
Loads a WLanguage code file in a Code Editor control.
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.
spIterationCount (Property)
The spIterationCount property is used to:
  • Get the iteration count of the hash algorithm used for an item of type "Password". This property can be used for items of type "Password" defined in the data model editor or programmatically.
  • Sets the iteration count of the hash algorithm used for an item of type "Password" (only for "Password" items described programmatically).
<Connection variable>.DeleteScheduling (Function)
Delete a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
gpwBiometricAuthentication (Function)
Enables biometric authentication for the connected user or retrieves the current status for the connected user.
<Image variable>.Clear (Function)
Clears the content of an Image variable and fills it with the specified color.
gpwCheckPassword (Function)
Checks a password (encrypted or not).
MapItineraryDistance (Function)
Calculates the distance of an itinerary in a Map control.
DDERecipient (Function)
Identifies the recipient of a DDE connection.
ScanGet (Function)
Retrieves the characteristics of a scanner in a variable of type Scanner.
IntervalYSecondaryAxis (Property)
The IntervalYSecondaryAxis property gets the interval between marks on the secondary Y-axis.
ImageLast (Function)
Displays the last image for the scroll.
EmulateSimulator (Function)
Emulates the window of the mobile (Android/iOS) simulator.
<Window>.Restore (Function)
Displays a WINDEV window to its initial size.
LDAPListAttribute (Function)
Lists the object attributes in an LDAP server.
NotesNbAttachment (Function)
Returns the number of files attached to an item of the current document in Lotus Notes.
EmulateInfo (Function)
Emulates the next call to Info and automatically clicks the "OK" button.
<WDPic variable>.DrawTextMarkdown (Function)
Draws Markdown text in a variable of type WDPic.
StartDatePeriodDisplayed (Property)
The StartDatePeriodDisplayed property gets the start date of the range displayed in a Scheduler or Organizer control of a report.
MapDeleteImage (Function)
Deletes an image drawn on the map displayed in a Map control.
GenerateGeometricImage (Function)
Randomly generates an image with geometric shapes. This image can be used to temporarily fill an Image control, for example.
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.
tapiCallDuring (Function)
Returns the duration of the call (difference between the start date and time of call and the end date and time of call).
SysThumbnailDeleteButton (Function)
Deletes one of the buttons found in the thumbnail of the application from the taskbar.
BTOpenDeviceProperties (Function)
Opens the window of properties for a Bluetooth device.
SchedulerSelectedRange (Function)
Returns the start or end date and time of the time slot selected in a Scheduler control.
DocEndModification (Function)
Signals the end of the grouping of a set of operations into a single event (undo/redo management).
HtmlFormat (Property)
The HtmlFormat property is used to:
  • find out whether an edit control accepts the input in HTML format.
  • modify the input format of an edit control.
SysNameExe (Function)
Returns the name and full path of an application.
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.
<Word Processing>.EndModification (Function)
Indicates the end of a series of actions performed in a Word Processing control in a single event ("undo/redo").
TestCheckNull (Function)
Checks whether an expression is Null in assertive programming and in automated test mode.
nWDInitProject: Project initialization code
Run the project initialization code...
<Command variable>.ReadStandardOutput (Function)
Reads standard output data, for the command executed in console mode.
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.
SpreadsheetGetSelection (Function)
Retrieves the list of selected cells in a Spreadsheet control found in a window.
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.
<Chart>.Scatter3DAltitudeColor (Function)
Defines the different colors used according to the altitude levels of a series found in a 3D Scatter chart.
Address (Property)
The Address property is used to:
  • Establish a connection between the Conference control (and the associated stream) and the receiver. This property is equivalent to StreamConnect.
  • Get the address of the last outgoing connection request.
LogDirectory (Property)
The LogDirectory property is used to manage the directory of the log file described in the database schema.
ClipboardUnicode (Function)
Returns the text found in the clipboard in Unicode format.
SysNotificationRemoveID (Function)
Removes all previously sent interactive notifications that match the specified identifier (ID).
<Polygon2D variable>.IsValid (Function)
Checks whether the specified 2D polygon is valid according to the OGC rules.
List (Property)
The List property is used to handle the different lists of a Kanban control. You can add, modify or delete lists from a Kanban control, or navigate between them.
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.
GglListContactByRequest (Function)
Retrieves a list of contacts from custom parameters.
VisualEffect (Property)
The VisualEffect property allows you to apply a visual effect on a control or group of controls in a window.
GanttListLink (Function)
Lists the links in a Gantt Chart column in a Table or TreeView Table control.
<Gantt chart>.ListLink (Function)
Lists the links in a Gantt Chart column in a Table or TreeView Table control.
tapiCallStart (Function)
Returns the date and time of the beginning of call (incoming or outgoing call).
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.
WidgetProcedure (Function)
Specifies the procedure that will be called when the user clicks an iOS 14 widget.
SysValidHandle (Function)
Checks the validity of a window handle.
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.
HandwrittenInput (Property)
The HandwrittenInput property is used to manage stylus or mouse input (Windows XP Tablet PC or Windows Vista, respectively).
grWndSize (Function)
Defines the size of the window containing the chart.
Error 705: The property does not exist on this type
Colors an area in a picLayer variable.
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).
IncomingData (Property)
The Receive property is used to identify and modify the type of incoming data transferred by the stream.
Looper controls populated programmatically: Operations in WLanguage
Here is an overview of how to handle Looper controls populated programmatically in WLanguage.
HTMLEditorInsertTable (Function)
Inserts a table at the cursor position in an HTML Editor control.
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.
HNotifDeleteCCRecipient (Function)
Deletes the recipients of a notification sent via the Control Centers (WDBal messaging tool).
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.
ArrayDelete (Function)
Deletes an element at a given position:
  • from a one-dimensional WLanguage array.
  • from an advanced array property (array of gglCalendar events, etc.).
  • from an associative array.
  • from a WLanguage list.
DayBreakHeight (Property)
The DayBreakHeight property gets and sets the height of breaks between days in a Scheduler control where days are arranged in rows, and resources are arranged in columns.
SpreadsheetDeleteImage (Function)
Deletes an image from the current worksheet in a Spreadsheet control.
NbAnimationSteps (Property)
The NbAnimationSteps property is used to get and specify the number of drawings in the image that defines the animation of a custom infinite Progress Bar control.
NotesDocumentLast (Function)
Positions on the last document found in Lotus Notes.
CodeEditorGetError (Function)
Gets a compilation error from the code in the Code Editor control.
ASPExecute (Function)
Calls an external .asp script and returns the result in a string.
<upnpDevice variable>.ModifyContrast (Function)
Modifies the contrast of a UPnP device.
TwainSourceWidth (Function)
Returns the width (in millimeters) of the document captured by a Twain device.
<Window>.PaletteGet (Function)
Gets the palette currently used by the window.
<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.
BannerNext (Function)
Displays the next plane of a Sliding Banner control.
Mini preview window
When printing a report through programming or using iPrint, it is now possible to request the use of a mini preview instead of the traditional preview.
InsertReference (Function)
Adds the reference of an object at given position in a one-dimensional array.
NotesDocumentNext (Function)
Positions on the document found after the current document in Lotus Notes.
BreakDeleteAll (Function)
Deletes all breaks from a Table control or from a Looper control.
<Tab>.Close (Function)
Closes a dynamic pane in a Tab control.
SchedulerToiCalendar (Function)
Exports the appointments from a Scheduler control in iCalendar format.
RibbonAdaptSize (Function)
Adapts the size of the controls found in a Ribbon control according to the size of their caption.
Aligning elements in a List Box or Combo Box control
There are different methods to align the elements in a List Box or Combo Box control...
HClearWorkingDir (Function)
Clears and destroys the temporary directory previously created when HServerWorkingDir was executed.
<Image>.StopScrolling (Function)
Stops the automatic image sliding.
GanttDeleteAll (Function)
Removes all tasks from a Gantt Chart column in a Table or TreeView Table control.
LockAppOn (Function)
Locks a WINDEV application.
LDAPValidateModify (Function)
Validates the modification of an existing object in an LDAP server.
<Spreadsheet>.GetSelection (Function)
Retrieves the list of selected cells in a Spreadsheet control found in a window.
DomoClose (Function)
Closes the communication opened by DomoOpen.
Canada.CheckBN15 (Function)
Checks the validity of a Canadian 15-digit Business Number (BN15).
SpreadsheetSelectWorksheet (Function)
Selects a worksheet (identified by its name) in a Spreadsheet control.
TestCheckTrue (Function)
Checks whether an expression is set to True in assertive programming and in automated test mode.
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...
J2EERunXML (Function)
Runs a procedure on a server of J2EE XML web services.
AnimationMinFPS (Function)
Configures the minimum number of images per second in order for the animations (transition effects) to be enabled in the controls.
<HTML editor>.ToPDF (Function)
Exports the content of an HTML Editor control to a PDF file.
Objective C: Calling a WLanguage procedure
A global procedure in WLanguage can be called from the code of a global procedure in Objective-C...
MaxAutoID (Property)
The MaxAutoID property is used to get the maximum automatic identifier of a replicated table.
BTInfoRadio (Function)
Returns specific information about a Bluetooth radio connected to the computer.
DDEError (Function)
Returns the runtime status report of a DDE function.
Hasp (Function)
Interrogates an electronic HASP key (HASP-3, HASP-4, MemoHasp or NetHasp).
MDIActive (Function)
Identifies or displays an MDI child window in the foreground.
DocClearFormatting (Function)
Replaces the current formatting of a selection with the default formatting.
DriveDownloadFile (Function)
Downloads a file from a remote drive to the user's computer.
ImageInfoClose (Function)
Closes the image file (in JPEG or TIFF format) used by ImageInfoValue and/or ImageInfoList and frees the image from memory.
LDAPReset (Function)
Reinitializes the LDAPSession structure with the default values.
SysNumberScreen (Function)
Returns the number of screens currently connected to the current computer.
StreamAccept (Function)
Associates a stream connection request with a Conference control.
FlexColumnGap (Property)
The FlexColumnGap property gets and sets the size of the gutter that separates the columns of a Flexbox control.
CaptchaVerify (Function)
Checks whether the value typed by the user corresponds to the string displayed in a Captcha control.
WinRateDDW (Function)
Gets and sets the dimming rate for windows that use the DDW (Dim Disabled Windows) feature.
FormulaBarVisible (Property)
The FormulaBarVisible property is used to:
  • Determine if a formula bar is displayed in a Spreadsheet control.
  • Show or hide a formula bar in a Spreadsheet control.
BackgroundTaskDelete (Function)
Deletes a background task (that was added by BackgroundTaskAdd).
Linestring2DAddPoint (Function)
Adds a new point to a 2D linestring.
BitcoinCoreDateTimeLatestBlock (Function)
Returns the date and time when the latest block was created.
ScreenCastAllowed (Property)
The ScreenCastAllowed property is used to:
  • find out whether the user can cast the content displayed in the Multimedia control to an external device (compatible with AirPlay),
  • allow or prevent the user from casting the content displayed in the Multimedia control to an external device (compatible with AirPlay).
<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.
SysIconDeleteImage (Function)
Deletes the icon that overlays the application icon in the taskbar.
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.
ExplorerAccept (Function)
Enables or disables the ability to perform "Drag and Drop" from the Windows explorer to a WINDEV window or 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...
Error 706: The property does not exist on this type of control
Determines if a cell is merged with other cells and gets the merged cell range.
TransparencyMode (Property)
The TransparencyMode property gets and sets the transparency mode of an image.
LDAPDisconnect (Function)
Used to disconnect from a specific LDAP server.
1
…
8