WINDEV 22

Documentation version 22 (1) - 0417

Remember to visit the download section of www.windev.com on a regular basis to check

whether upgraded versions are available.

Email address of Free Technical Support: [email protected]

This documentation is not contractually binding. PC SOFT reserves the right to modify or delete
any topic dealt with in this document.

All product names or other trademarks mentioned in this publication are registered trademarks of their respective owners.
© PC SOFT 2017: This publication may not be reproduced in part or in whole in any form without the express permission of PC SOFT.
Summary
Introduction
Preliminary points.................................................................................................................................................. 15
Overview of the tutorial.......................................................................................................................................... 15
Legend of symbols used in this guide................................................................................................................... 16
How to access the online help?............................................................................................................................. 16
If you are familiar with WEBDEV 21...................................................................................................................... 19
What is WINDEV used for?..................................................................................................................................... 19

PART 1 - Discovering WINDEV

Lesson 1.1.  Discover WINDEV

Overview.................................................................................................................................................................. 24
Starting WINDEV..................................................................................................................................................... 24
Development environment.................................................................................................................................... 25
The editor.................................................................................................................................................. 25
The menu bar (ribbon) in details.............................................................................................................. 26
The environment colors........................................................................................................................... 27

Lesson 1.2.  My first window

Overview.................................................................................................................................................................. 29
Opening the project.................................................................................................................................. 29
My first window: typing and displaying data........................................................................................................ 30
Overview................................................................................................................................................... 30
Creating the window................................................................................................................................. 30
Entering and displaying the value typed................................................................................................. 31
Window improvements............................................................................................................................ 36
WINDEV: Main concepts and terminology............................................................................................................ 38
Main concepts.......................................................................................................................................... 38
Terminology.............................................................................................................................................. 39

PART 2 - The basics of WLanguage

Lesson 2.1.  The variables

What is a variable?.................................................................................................................................................44
Declaring a variable................................................................................................................................. 45
Assignment and use................................................................................................................................ 45
The types of variables............................................................................................................................................. 46
The scope of variables............................................................................................................................................ 46
Global scope............................................................................................................................................. 46
Local scope............................................................................................................................................... 47
Summary scope diagram......................................................................................................................... 47

Summary 3
 Simple operations on the variables...................................................................................................................... 48
Tips............................................................................................................................................................ 49
The String variables in details............................................................................................................................... 49
The String type.......................................................................................................................................... 49
Practical example..................................................................................................................................... 50
The array variables in details.................................................................................................................................54
Declaration............................................................................................................................................... 54
Filling an array and accessing the elements........................................................................................... 54
Advanced arrays....................................................................................................................................... 55

Lesson 2.2.  The conditional statements

Overview.................................................................................................................................................................. 57
The IF and SWITCH statements............................................................................................................................. 57
The IF statement...................................................................................................................................... 57
The SWITCH statement............................................................................................................................ 58
Practical example: Using the IF and SWITCH statements................................................................................... 59
Project used.............................................................................................................................................. 59
Creating the window................................................................................................................................. 60
Creating controls in the window for the IF statement............................................................................. 60
IF statement............................................................................................................................................. 61
Creating controls in the window for the SWITCH statement................................................................... 62
SWITCH statement................................................................................................................................... 63

Lesson 2.3.  The loops

Overview.................................................................................................................................................................. 66
The FOR statement.................................................................................................................................. 66
The LOOP statement................................................................................................................................ 66
The WHILE statement.............................................................................................................................. 67
Practical example: Using loops............................................................................................................................. 68
Project used.............................................................................................................................................. 68
Creating the window................................................................................................................................. 68
Creating the controls................................................................................................................................ 68
Window test.............................................................................................................................................. 71

Lesson 2.4.  The procedures

Overview.................................................................................................................................................................. 73
Types of procedures............................................................................................................................................... 73
Creating and calling a procedure.......................................................................................................................... 73
Global procedure...................................................................................................................................... 73
Local procedure........................................................................................................................................ 73
Internal procedure.....................................................................................................................................74
Calling a procedure...................................................................................................................................74
Parameters of a procedure.................................................................................................................................... 74
What is a parameter?................................................................................................................................74
How to use the parameters?.................................................................................................................... 75
Mandatory or optional parameters?....................................................................................................... 76
Result of a procedure............................................................................................................................................. 76

4 Summary
Practical example: Using a procedure.................................................................................................................. 77
Project used.............................................................................................................................................. 77
Implementation........................................................................................................................................ 77
Creating and using a procedure.............................................................................................................. 80
Conclusion............................................................................................................................................................... 81

Lesson 2.5.  Questions/Answers

Questions/Answers................................................................................................................................................ 83
How to view the element to which the current process belongs?.......................................................... 83
How to print the source code?................................................................................................................. 83
How to perform a “find and/or replace”?................................................................................................ 83
What is the meaning of the “+” and “-” signs in the code editor?.......................................................... 84
Is it possible to identify the person who wrote a code line?................................................................... 84
Is it possible to find out the number of a code line?............................................................................... 84
Is there a method to easily display the syntax or the help about a function?........................................ 85
What are the useful shortcuts in the code editor?................................................................................. 85
How do I communicate with the user?.................................................................................................... 86

PART 3 - My first database

Lesson 3.1.  Overview

Overview of the project developed in this part..................................................................................................... 90

Lesson 3.2.  WINDEV and the databases

Overview.................................................................................................................................................................. 92
HFSQL...................................................................................................................................................................... 92
The different modes for accessing the databases.............................................................................................. 93
Native Connector (Native Access)........................................................................................................... 93
Direct ODBC access................................................................................................................................. 94
OLE DB access......................................................................................................................................... 94
ODBC access via OLE DB......................................................................................................................... 94

Lesson 3.3.  Project and analysis

Overview.................................................................................................................................................................. 96
Creating the project................................................................................................................................................ 96
Creating the analysis.............................................................................................................................................. 98
Creating the description of data files.................................................................................................................... 99
Creating a data file: using a preset file..................................................................................................100
Creating a data file: creating the file and items.................................................................................... 101
Importing a CSV file................................................................................................................................106
Direct import of existing data files.........................................................................................................109
Creating links....................................................................................................................................................... 109
Generating the analysis...................................................................................................................................... 116

Summary 5
 Lesson 3.4.  The full RAD
What is RAD?....................................................................................................................................................... 119
Generating RAD................................................................................................................................................... 120
Application test.................................................................................................................................................... 123

PART 4 - Full application with data

Lesson 4.1.  Overview

Overview of the application created in this section.......................................................................................... 128
Projects supplied................................................................................................................................................. 128
Example project......................................................................................................................................128
Corrected projects..................................................................................................................................130

Lesson 4.2.  Addition and modification windows

Overview............................................................................................................................................................... 132
Creating a window used to list the products...................................................................................................... 132
Creating the window...............................................................................................................................132
Creating the controls..............................................................................................................................134
Window test............................................................................................................................................136
Creating a "Product form" window..................................................................................................................... 139
Creating the window...............................................................................................................................139
Creating edit controls.............................................................................................................................139
Creating buttons.....................................................................................................................................142
Improving the interface of the window..................................................................................................142
Displaying the form from the list of products........................................................................................146
Managing the modification of a product........................................................................................................... 148
Modifying the image of the product.......................................................................................................148
Validate the modifications made to the product...................................................................................149
Checking the modification of a product................................................................................................ 151
Creating a new product....................................................................................................................................... 152
Adding a button......................................................................................................................................152
Addition into the data file.......................................................................................................................153
Checking the addition of a product.......................................................................................................154
Viewing the records................................................................................................................................155

Lesson 4.3.  Simple search and record browse

Overview............................................................................................................................................................... 158
Modifying the window: using a Tab control....................................................................................................... 159
Creating the Tab control.........................................................................................................................159
Modifying the Tab control....................................................................................................................... 161
Implementing the search................................................................................................................................... 163
Area for displaying the information found.............................................................................................163
Exact-match search................................................................................................................................164
Generic search.......................................................................................................................................169
Browsing forms....................................................................................................................................... 171
Window test............................................................................................................................................ 174

6 Summary
Lesson 4.4.  Multicriteria search
Overview................................................................................................................................................................176
Creating the query used to find the orders.........................................................................................................177
Creating the query.................................................................................................................................. 177
Query test...............................................................................................................................................180
Using parameters in the query..............................................................................................................181
Test of query with parameters...............................................................................................................184
Creating the interface used to perform a multicriteria search........................................................................ 184
Modifying the Tab control.......................................................................................................................184
Creating the controls used to configure the criteria and to display the result.....................................186

Lesson 4.5.  Printing the content of a Table control

Overview............................................................................................................................................................... 198
Printing the content of a Table control............................................................................................................... 199
Direct print via the AAF (Automatic Application Feature).....................................................................199
Creating an automatic report on a Table control..................................................................................201

Lesson 4.6.  Printing an order

Overview............................................................................................................................................................... 204
Creating the "Order form" report........................................................................................................................ 204
Creating the query..................................................................................................................................205
Creating the report based on a query....................................................................................................208
Modifying the "Order form" report.........................................................................................................215
Displaying the printed report from a menu option............................................................................................216
Creating the popup menu...................................................................................................................... 216
Associating the popup menu with the Table control.............................................................................218
Print test.................................................................................................................................................218

Lesson 4.7.  Printing a list of customers

Overview............................................................................................................................................................... 221
Creating the report.............................................................................................................................................. 221
Starting the report print by programming......................................................................................................... 228

Lesson 4.8.  Statistics: Chart and Pivot Table controls

Overview............................................................................................................................................................... 232
Displaying data in a Chart control...................................................................................................................... 232
Selecting the data that will be displayed in the Chart control..............................................................232
Creating the Chart control.....................................................................................................................235
Creating summary tables with the Pivot Table control.................................................................................... 239
Creating the Pivot Table control.............................................................................................................240
Test of Pivot Table...................................................................................................................................243

Summary 7
 Lesson 4.9.  Sending an email
Overview............................................................................................................................................................... 246
A window for sending emails...............................................................................................................................247
Creating the window............................................................................................................................... 247
Creating the controls used to configure the sending............................................................................ 247
Creating the controls used to enter the characteristics of the email...................................................249
Sending the email..................................................................................................................................251
Window improvements....................................................................................................................................... 253
Closing the window................................................................................................................................253
Formatting..............................................................................................................................................253
Non-modal opening of the window........................................................................................................254

Lesson 4.10.  Identifying the user: the user groupware

Overview............................................................................................................................................................... 257
Integrating the user groupware.......................................................................................................................... 257
Configuring the user groupware..........................................................................................................................261
Creating the users and the groups........................................................................................................261
Defining the rights..................................................................................................................................263
Application test.......................................................................................................................................265
Disabling the management of user groupware................................................................................................ 266

Lesson 4.11.  Re-use code via the external components

Overview............................................................................................................................................................... 268
Teamwork...............................................................................................................................................268
The huge projects...................................................................................................................................268
The databases accessed by several projects.......................................................................................269
The processes used in several projects................................................................................................269
The ability to distribute a feature or set of features..............................................................................269
Multi-product external component........................................................................................................269
Step by step.......................................................................................................................................................... 270
Step 1: Creating an external component..............................................................................................270
Step 2: Using the external component..................................................................................................275
Distributing an external component.................................................................................................................. 278
Standard distribution.............................................................................................................................278
Professional distribution........................................................................................................................279

Lesson 4.12.  Consuming a Webservice

Overview............................................................................................................................................................... 281
Practical example...................................................................................................................................281
Importing a Webservice...................................................................................................................................... 281
Consuming a Webservice................................................................................................................................... 284

Lesson 4.13.  Monitor the evolution of your applications

Overview............................................................................................................................................................... 287
The dashboard..................................................................................................................................................... 287
Automatic tests................................................................................................................................................... 288

8 Summary
Lesson 4.14.  Deploying the application
Overview............................................................................................................................................................... 293
Creating the executable...................................................................................................................................... 293
Creating the setup............................................................................................................................................... 298
Installing an application..................................................................................................................................... 301
The different types of deployment..................................................................................................................... 302
Overview.................................................................................................................................................302
Setup with network update....................................................................................................................303
Setup with Internet update....................................................................................................................305
Multisite setup........................................................................................................................................305

Lesson 4.15.  Distribute "Reports and Queries" with your applications

Starting "Reports and Queries".......................................................................................................................... 308
Configuring the project...........................................................................................................................309
Configuring the analysis.........................................................................................................................309
Configuring the reports.......................................................................................................................... 310
Configuring the queries.......................................................................................................................... 311
Creating the executable and distributing the application.................................................................... 311
Installing and using "Reports and Queries"...................................................................................................... 313
Installing the application....................................................................................................................... 313
Application test....................................................................................................................................... 315
Conclusion.............................................................................................................................................................317

Lesson 4.16.  Managing the multilingual feature

What is a multilingual application?....................................................................................................................319
Choosing the project languages..........................................................................................................................319
Localizing the analysis........................................................................................................................................ 321
Localizing the project elements......................................................................................................................... 323
Localizing an image................................................................................................................................324
Localizing the controls...........................................................................................................................325
Localizing a programming message......................................................................................................325
Localizing the menus.............................................................................................................................326
The translation tools............................................................................................................................................ 327
Direct input of translations....................................................................................................................327
Translation with WDMSG and WDTRAD................................................................................................328
Other elements to translate: the framework messages.......................................................................328
Programming the change of language.............................................................................................................. 329
Adding a menu option............................................................................................................................329
Programming..........................................................................................................................................329
Project test..............................................................................................................................................330

Summary 9
 Lesson 4.17.  SCM
Introduction.......................................................................................................................................................... 332
SCM (Source Code Manager).............................................................................................................................. 332
Principle of SCM.....................................................................................................................................332
Creating the SCM database...................................................................................................................333
Including a project in the SCM............................................................................................................................ 334
Adding the project into the SCM............................................................................................................334
Opening a project from the SCM............................................................................................................337
Configuring the SCM..............................................................................................................................338
Handling the project via the SCM....................................................................................................................... 339
Modifying a project parameter..............................................................................................................339
Modifying a project window...................................................................................................................340
Checking the checked-out element back in..........................................................................................342
Synchronizing the project......................................................................................................................343
Off-line mode (or mobile mode).............................................................................................................344
SCM administrator.................................................................................................................................344
Disconnecting from the SCM.................................................................................................................345
Conclusion............................................................................................................................................................ 345

PART 5 - Managing a HFSQL Client/Server database

Lesson 5.1.  Introduction

Overview............................................................................................................................................................... 350
Why switch an application to HFSQL Client/Server mode?............................................................................. 351

Lesson 5.2.  Implementation of a Client/Server database

Overview............................................................................................................................................................... 353
Installing a local HFSQL server........................................................................................................................... 353
Creating an application that is using a HFSQL Client/Server database......................................................... 354
Adapting an application to use a HFSQL Client/Server database.................................................................. 354
Overview.................................................................................................................................................354
Adapting the example............................................................................................................................354
Features available in HFSQL Client/Server mode............................................................................................ 358

Lesson 5.3.  Managing a Client/Server database

Overview............................................................................................................................................................... 360
Configuring the computers................................................................................................................................. 360
The HFSQL Control Center.................................................................................................................................. 360
Creating a user account in the HFSQL Control Center...................................................................................... 362
Saving the database............................................................................................................................................ 367
Conclusion............................................................................................................................................................ 367

Lesson 5.4.  Setup on end-user computers

Overview............................................................................................................................................................... 369
Starting the wizard for setup creation............................................................................................................... 369

10 Summary
PART 6 - Optimizing and debugging a project

Lesson 6.1.  Overview

Overview................................................................................................................................................................374
Opening the project................................................................................................................................ 374

Lesson 6.2.  Project audits

What is an audit?..................................................................................................................................................376
Static audit............................................................................................................................................................376
Procedure not run..................................................................................................................................378
Orphan element.....................................................................................................................................379
Query to optimize...................................................................................................................................380
Cleaning the project...............................................................................................................................381
Dynamic audit...................................................................................................................................................... 381

Lesson 6.3.  Performance profiler

Overview............................................................................................................................................................... 386
Starting the performance profiler...................................................................................................................... 386
Analyzing the result............................................................................................................................................. 387

Lesson 6.4.  Debugging a project

Overview.............................................................................................................................................................. 393
Using the debugger............................................................................................................................................. 393

PART 7 - Advanced programming

Lesson 7.1.  Overview

Overview............................................................................................................................................................... 402
Practical example...................................................................................................................................402

Lesson 7.2.  Automatic management of errors

Overview............................................................................................................................................................... 404
Operating mode......................................................................................................................................404
Implementation......................................................................................................................................404
Types of affected errors.........................................................................................................................405
Automatic management of errors: a training example.................................................................................... 405

Lesson 7.3. Handling external files

Overview................................................................................................................................................................410
Handling text or CSV files.....................................................................................................................................410
Overview................................................................................................................................................. 410
Practical example................................................................................................................................... 410
Handling directories.............................................................................................................................................411
Practical example................................................................................................................................... 411

Summary 11
 Handling XML files............................................................................................................................................... 412
Overview................................................................................................................................................. 412
Practical example................................................................................................................................... 413
Handling XLS files................................................................................................................................................ 413
Practical examples................................................................................................................................. 414

Lesson 7.4.  Dynamic compilation

Overview................................................................................................................................................................416
Example.................................................................................................................................................................416

Lesson 7.5.  Windows event

Introduction...........................................................................................................................................................419
Practical example................................................................................................................................... 419
Optional processes proposed by WINDEV..........................................................................................................419
Windows events................................................................................................................................................... 420
Example: Detecting the click on a list....................................................................................................421

Lesson 7.6.  The threads

Definition.............................................................................................................................................................. 424
Example................................................................................................................................................................ 424

Lesson 7.7.  The sockets

Overview............................................................................................................................................................... 426
Server application: simplified server................................................................................................................. 426
Creating the socket................................................................................................................................426
Exchanging data.....................................................................................................................................426
Closing the socket..................................................................................................................................427
Client application................................................................................................................................................. 427
Connecting to the server........................................................................................................................427
Exchanging data.....................................................................................................................................427
Ending the communication....................................................................................................................427
Practical example................................................................................................................................................ 428
Example test...........................................................................................................................................428
Analyzing the code used........................................................................................................................428

Lesson 7.8.  The FTP

Overview................................................................................................................................................................431
Connecting to an FTP server................................................................................................................................431
Sending a file....................................................................................................................................................... 432
Listing the files found on an FTP server............................................................................................................. 433
Retrieving a file.................................................................................................................................................... 434
Disconnecting from an FTP server..................................................................................................................... 434

12 Summary
Lesson 7.9.  The OOP
Concepts............................................................................................................................................................... 436
The classes.............................................................................................................................................436
The objects.............................................................................................................................................436
The members.........................................................................................................................................436
The methods...........................................................................................................................................436
Concept of inheritance...........................................................................................................................436
Constructor and Destructor...................................................................................................................437
Data encapsulation................................................................................................................................437
Example..................................................................................................................................................437
Creating an object-oriented program....................................................................................................437
Simple example................................................................................................................................................... 438
Declaring a class....................................................................................................................................438
Describing the methods.........................................................................................................................439
Declaring and handling the objects......................................................................................................440
UML diagram........................................................................................................................................................ 441

PART 8 - Appendices

Appendice 1.  Vocabulary

Main terms used.................................................................................................................................................. 446

Appendice 2.  Using SQL data

Overview............................................................................................................................................................... 453
Creating the project............................................................................................................................................. 453
Creating the analysis........................................................................................................................................... 455
Generating the analysis...................................................................................................................................... 457

Conclusion

Summary 13
 14 Summary
 Introduction

Preliminary points
Caution: This manual is a tutorial. We advise you to refer to the online help when you are using
WINDEV.
The aim of the tutorial is to help you discover WINDEV, become familiar with the editors and teach
you the WINDEV concepts.
This manual does not cover all the features of WINDEV.
You should plan on spending a few hours to follow this course and to learn WINDEV: you'll find it
was well worth it!
If you try to develop an application before following this tutorial, you will lose time, and a lot more
than the few hours you'll spend on this tutorial.
This tutorial was designed to be followed in two different ways:
• either you follow all the detailed exercises in each lesson (recommended method).
• or, if you are in a hurry and already experienced, you can read it without doing the exercises
(all the exercises have screen shots). However, in order to quickly assimilate the main
concepts, we recommend that you follow the tutorial step by step.
WINDEV evolves all the time, so the screen shots found in this course may differ from the windows
displayed in your product.

Overview of the tutorial

The tutorial was designed to progressively teach you how to use WINDEV. By following this course:
• you will discover the main concepts explained informally ; these are the concepts you must
learn and understand.
• you will also be asked to perform operations that illustrate the concepts just explained.
As you progress through the tutorial, if you want to take a closer look at a concept or if you want to
get more details about a programming function, see the online help (directly accessible from the
editors or from the guide).
The size of a lesson is not necessarily proportional to its relevance...
Don't forget to also take a look at the dozens of examples supplied with WINDEV: they are very
instructive!

Introduction 15
 Legend of symbols used in this guide

This symbol indicates the duration of the lesson. Please note that the actual time may
vary according to your level of experience.
An example is available to complement the lesson. The examples are available via the
home window of WINDEV.

This symbol introduces a "Tip": we strongly advise you to read the associated text.

This symbol introduces a "Warning": reading the associated text is extremely important.

This symbol introduces a "Note": we recommend that you read the associated text.

The tutorial may have evolved since this document was published. Don't hesitate
Notes

to check the electronic version of the tutorial (PDF file accessible from the
WINDEV menu: on the "Home" pane, in the "Online help" group, expand "Tutorial"
and select "Tutorial (PDF)".

How to access the online help?

The online help of WINDEV allows you to get detailed information about the 2500 WLanguage
functions. It also contains the help about the editors and the controls, tips, ...
The online help is available at any time in WINDEV:
• In the code editor, a specific help is available for each function via the [F1] key.
• The dialog windows displayed by WINDEV can propose a button allowing you to access the
corresponding help page.
• The help menu of the editors ("Help" option available on the "Home" pane, in the "Online help"
group of the WINDEV menu) allows you to start the online help.

16 Introduction
The help can be displayed:
• in a specific "help browser":

• in an Internet browser, if you have access to Internet:

Introduction 17
 We advise you to check the online help on Internet rather than the local online
help. Indeed, the Internet online help is updated on a regular basis.
The online help of WINDEV, WEBDEV and WINDEV Mobile on Internet is available
Notes

from any computer equipped with an Internet access, without the product being
necessarily installed.
Each Web user can add comments about the documentation pages: personal
notes, examples, links...

To start the Internet online help from the product:

1. On the "Home" pane, in the "Environment" group, expand "Options" and select "General
options of WINDEV".
2. In the "Help" tab, select:
• the access mode to the help database.

• the content of the help: help common to WINDEV, WEBDEV and WINDEV Mobile or help
about the product currently used.

18 Introduction
If you are familiar with WEBDEV 21...
If you are familiar with WINDEV 21, following this tutorial will do no harm: it's a good opportunity to
"review" the WINDEV features!

What is WINDEV used for?

WINDEV is an IDE (Integrated Development Environment). It allow you to develop applications in
many fields:
• Stock management, inventory, product tracking,
• Adjustment and monitoring of machines on an assembly line,
• Taking orders for fast processing in a temporary outlet (fairs, schools, booth, ...),
• Customer forms,
• Help with making snap decisions on a cell phone,
• Checking the identity of visitors at an event: trade fair, presentation of products, ...
• On-call doctors or vets,
• Taking information in a temporary outlet: trade fair, street poll, stadium, ...
WINDEV is an integrated development environment that includes all the tools required to develop
an application.
Unlike other programming languages, there is no need to find and add modules to be able to
design, check and install an application.
The 5GL (5th Generation Language) of WINDEV, named WLanguage, will surprise you by its
simplicity: a few hours are all you need to get the hang of it, a week is usually all it takes to fully
master its potential!
No more programming hassle, WLanguage is available in English and in French!

Introduction 19
 20 Introduction
 PART 1

Discovering
WINDEV
 22 Part 1: Discovering WINDEV
 Lesson 1.1.  Discover WINDEV

This lesson will teach you the following concepts...

• Starting WINDEV

Estimated time: 5 min

Part 1: Discovering WINDEV 23

 Overview
WINDEV is an IDE (Integrated Development Environment) allowing you to develop Windows
applications in several fields: management, industry, health care, ... The developed applications
can give access to information stored in the databases.
As you go through this tutorial, you will learn to create your own applications (with or without
database) and to improve them by using the features proposed by WINDEV.

Starting WINDEV

Start WINDEV 22 (if not already done).

If WINDEV 22 was never started before, a welcome wizard is displayed:
• If you worked with an earlier WINDEV version, this wizard allows you to retrieve the existing
configurations.
• If you are a new user, this wizard allows you to configure your environment. This allows you to
choose the screen configuration used and to configure the Control Centers. See the online
help for more details.
If WINDEV 22 was already started, identify yourself if necessary. The development
environment starts. The home window is displayed. This home window is used to:
• create a project,
• open an existing project,
• open an example,
• open one of the projects found in the tutorial.
Let's take a closer look at the development environment of WINDEV. To do so, from the home
window:
• Click "Tutorial".
• Double-click "Full application (with windows)".
• The corresponding project is opened in the editor.

24 Part 1: Discovering WINDEV

Development environment

The editor
The development environment of WINDEV includes a specific interface and several editors
allowing you to create the different elements of your applications.
For example, the window editor is used to create windows, the report editor is used to create
reports, ...
All the editors are using the same environment:

1. Menu of editors, displayed in the shape of a ribbon (we'll see how to use it in the next paragraph).
2. Current editor (window editor here). This space allows you to view the element currently created
or modified in WYSIWYG (What You See Is What You Get).
3. Panes. The WINDEV interface includes several horizontal and vertical panes allowing you to
quickly access different types of information. For example:
• the "Project explorer" pane (displayed on the right) is used to list all the project elements by
category.
• the search pane (displayed at the bottom) is used to perform searches in the entire project and
in its elements.
These panes can be hidden by pressing [CTRL] + [W] if necessary.
4. Bar of opened documents. This bar is used to quickly view all the opened elements. A simple
click on the button corresponding to the element displays it in its own editor.

Part 1: Discovering WINDEV 25

 The menu bar (ribbon) in details
The menu bar of WINDEV is presented like a ribbon. This ribbon includes panes in which the
options of the editors are grouped.
We are going to take a closer look at the main elements of the ribbon, as well as how we will be
using it in this tutorial.

The different ribbon elements

The ribbon includes 3 areas:
• the button area, on the left (1).
• the pane area, at the top (2).
• the option area (3).
Let's take a closer look at these areas.

The button area (1)

The button area groups the quick access buttons. These buttons are used to
perform the most usual operations, common to all the editors: save, open,
create, ...
The 3 logos found at the top of this area are specific:
• The product logo is used to display the "About" window, the custom menus
and the drop-down menus found in the former interface of the editors (version
17 and earlier).
• The 2 other logos are used to restore the toolbars and the drop-down
menus found in the former interface of the editors (version 17 and earlier).

The pane area (2)

The different ribbon panes are used to access the options of the different editors for the current
project. Several types of panes are available:
• the current pane: The tab of the pane appears in white and a light orange line is displayed at the
top of the tab.
• the popup panes, specific to the current element: The name of the pane is displayed in blue.
• the available panes: The name of the pane is displayed in black.
Depending on the selected environment theme (light or dark), the colors used to identify these
different panes are different. See “The environment colors”, page 27 for more details.

26 Part 1: Discovering WINDEV

The option area (3)

The options displayed in the ribbon differ according to the selected pane. Several types of options
are available:
• Options to check
• Buttons to click
• Button with arrow used to expand the options. Two types of buttons with arrow are available:
• the buttons with arrow used to expand a menu
• the buttons with arrow used to expand a menu (click on the arrow) or to perform a default
action (click on the button icon).
The options are organized by group. Each group of options has a name and it can also include a
group button . This button is used to perform a specific action according to the current group:
displaying the description of the current element, displaying the help, ...

In this tutorial, to identify a menu option, we will be talking about panes and groups.
For example:
To display the help, on the "Home" pane, in the "Online help" group, click "Help".

The environment colors

The environment is using a light theme by default.
Two other themes are also available:
• Light theme, grey ribbon. In this mode, the menu bar is not colored anymore: it is grayed.
• Dark theme. In this mode, the environment and the different windows of the interface are
displayed on a black or dark gray background.
To modify the theme used by the environment:
1. On the "Home" pane, in the "Environment" group, expand "Options" and select "General
options of WINDEV".
2. In the "Editor" tab, in the "Themes" area, select the theme to use.
3. Validate. The theme will be taken into account during the next start of WINDEV.

Note: To improve the readability of this manual, the light theme will be used for the different
images that illustrate the operations to perform.

Part 1: Discovering WINDEV 27

 Lesson 1.2.  My first window

This lesson will teach you the following concepts...

• How to create a window

• How to type a text and display it

Estimated time: 30 min

28 Part 1: Discovering WINDEV

Overview
To start working with WINDEV, we are going to create a window.

The windows are used to display or enter information on the screen. The user can
Note

directly act on the windows via controls, buttons, ...

Let's see how to:

• Open a project,
• Create and save a window,
• Enter and display data.
These first operations will present the main concepts for developing with WINDEV. Full topics will
be presented in the following sections.

Opening the project

Start WINDEV 22 (if not already done). Display the home window of WINDEV if necessary:
press [CTRL <].
Open the "WD My First Windows" project.
To do so, in the home window, click "Tutorial" and select the first project named "My first
windows (Exercise)".
Tip: if the home window is not displayed, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "My first windows (Exercise)".
Important

In this part, we will focus on creating simple windows. The "WD My First Windows"
project is an empty project that was already created. The creation of a project will
be presented in another lesson.

A corrected project is available. This project contains the different windows

created in this part (as well as the ones created in part 2). To open the corrected
project:
Answer

• in the home window, click "Tutorial" and select the project named "My first
windows (Answer)".
• on the "Home" pane, in the "Online help" group, expand "Tutorial" and select
"My first windows (Answer)".

Part 1: Discovering WINDEV 29

 My first window: typing and displaying data

Overview
You are going to create the following window:

This window allows the user to type his first name and to display a welcome message with the
"Display" button.
You may think this is too basic but we advise you to create this window. You may well be surprised
by how intuitive and easy it is to use the WINDEV editor. Furthermore, this window will teach you
principles that are fundamental for the rest of this tutorial.

Creating the window

To create the window:

1. Click among the quick access buttons of the WINDEV menu:

2. The window for creating a new element is displayed. This window is used to create all the
elements that can be associated with a project.
3. Click "Window" then "Window". The wizard for window creation starts.
4. Select "Blank" in the list of "standard" windows displayed on the left. In the list of skin
templates found on the right, the "Elegant" skin template is selected by default. You can
choose another skin template proposed in the list.

The skin templates allow you to quickly create outstanding interfaces. A skin
Note

template defines the style of the window as well as the style of all controls that
will be used in this window. No ugly interface anymore.

5. Validate. The window is automatically created in the editor. The backup window of the
created element is displayed. This window is used to specify:
• The title of the element. For a window, this title will be displayed in the title bar of the
window.
• The name of the element. This name corresponds to the logical name of the element. This
name will be used to handle the element by programming.
• The location of the element. This location corresponds to the backup directory of the
element.

30 Part 1: Discovering WINDEV

 6. Specify the title of the "My first window" element (in this case, the element corresponds to
the WINDEV window). The element name ("WIN_My_first_window") is automatically proposed.

Study the window name proposed by WINDEV: this name starts with the letters
"WIN_". This prefix is automatically added because the project is using a
programming charter.
The programming charter is used to define a prefix for each type of object,
allowing you to quickly identify the element:
Note

• a window starts with "WIN_",

• a button starts with "BTN_",
• etc.
If you do not want to use this charter, all you have to do is disable it: on the
"Project" pane, in the "Other actions" group, expand "Charter" and uncheck "Use
the charter".

7. In this example, we want to use a shorter window name: replace "WIN_My_first_window" by
"WIN_Welcome".

8. Click the green button to validate the information displayed in the backup window.

Entering and displaying the value typed

To enter and display of the value typed, you must create:
• a control where the user will type his first name. Therefore, this type of control is an "edit control".
• a button used to display the first name.

Part 1: Discovering WINDEV 31

 To create the edit control:
1. On the "Creation" pane, in the "Usual controls" group, expand "Edit" (click the arrow):

The list of edit controls proposed by default is displayed.

2. Click "Simple text" in the list of controls. The control currently created follows the move of
the mouse.
3. Move the mouse toward the position where the control will be created in the window (at the
top of the window for example). To drop the control in the window, all you have to do is perform
a new left mouse click.
4. Perform a right mouse click on the control that was just created. The popup menu of the
control is displayed. Select "Description" from the popup menu. The description window of the
edit control is displayed.
5. Modify the control characteristics by typing the following information:

• The name of this control is: "EDT_FirstName" (1).

• The caption of this control is: "First name" (2).
• This control is a text control (3).
6. Validate the description window of the control (green button). The control appears in the
window editor.

32 Part 1: Discovering WINDEV

The control caption is truncated in the editor. To display the control properly:
1. Select the control (all you have to do is click it with the mouse).
2. In the popup menu (right mouse click), select "Resize".
3. The control is immediately enlarged and the caption is entirely displayed.
Note: The input area of the control can also be enlarged manually:
1. Select the control.
2. Position the mouse cursor above one of the handles found on the right of the control (small
square). The mouse cursor turns into arrow.
3. Click with the left mouse button and keep the button down during the move used to enlarge
the control.
4. Release the mouse button once the control was resized.
To create the "Display" button:
1. On the "Creation" pane, in the "Usual controls" group, click .
2. Position the control in the window. Click the location where the button will be created (on
the right of the edit control for example).
3. Click the button that was just created. The text displayed in the button becomes editable.

To quickly edit the caption of a control, you also have the ability to:
Tip

• Select the control.

• Press the [ENTER] or [SPACE] key.

4. Type the caption: "Display". The name of the button automatically becomes "BTN_Display".
5. You can see the name of the button:
• in the tooltip displayed when hovering the control:

• in the status bar of the editor:

We are going to display the text typed in a dialog box (a mini-window proposed by the system).
To do so, we will be using our first WLanguage function: Info.

Part 1: Discovering WINDEV 33

 The programming language supplied with WINDEV is named WLanguage. It is
a 5th generation language (5GL) that includes highly sophisticated commands.
Main WLanguage conventions
• No ending character for end of line is used in WLanguage.
• The '//' characters are used to comment out code lines. These code lines are
not interpreted. They provide better code readability.
• In the WLanguage functions, the parameters passed to the function are
enclosed in brackets.
Notes

• The coma character corresponds to the parameter separator.

• WLanguage is not case sensitive.
• The "space" characters are not interpreted.
• The dot is the decimal separator.
• The name of WLanguage functions is in English. It is available in French.
• The name of WLanguage functions is using a prefix in order to regroup the
functions by family ("Win" for the functions handling windows, "email" for the
functions handling emails, ...).

1. Select the "Display" button with the mouse.

2. Display the popup menu of the control (right mouse click).
3. Select "Code". This option opens the code editor of WINDEV. This editor is used to enter all
the WLanguage statements.

The code editor proposes different processes for each type of control. These
processes correspond to the events linked to the control.
Therefore, two processes are displayed for the "Button" control:
Notes

• Initialization,
• Click on the button, run when the user clicks the button.
Note: Additional processes can be added if necessary.

4. Type the following code in the "Click on BTN_Display" process:

Info("Hello", EDT_FirstName)

Note about the assisted input: As soon as the first two characters are typed, WINDEV proposes all
the words of the WLanguage vocabulary containing these characters. The assisted development is
a very powerful feature. No more mistake when typing the name of an element: the syntax errors
are reduced. All you have to do is select the requested word and press the [ENTER] key to validate.
You can focus on the algorithm.

This is the reason why the programming charter is so important. All the elements
Notes

handled in the application code use the same standard so they can be easily
identified when typing code.

34 Part 1: Discovering WINDEV

 When typing this code in the code editor, you have noticed that different colors
are used by the different elements. This is the syntactic coloring. The code
Notes editor allows you to easily identify the different elements handled by the code.
Therefore, in the code editor that is using the light theme:
• the WLanguage functions are colored in blue,
• the character strings (between quotes) are colored in purple,
• the names of controls are colored in cyan.

The Info function displays the message passed in parameter on one or more lines. Our message
is built from the text "Hello " and from the value of the "EDT_FirstName" control. The "," character
separates the parameters found in the Info function. Each parameter is displayed on a different
line.
Notes

In this example, the text is displayed in a system window but it can also be
displayed it in a window created with WINDEV.

Let's now run the window test:

1. Click among the quick access buttons (or press [F9]).
2. The window that was just created is automatically saved then it is started in execution.
3. Type your first name.
4. Click the "Display" button.
5. Validate the system window that is displayed (click the "OK" button).
Any developer knows that running a program test can be a long and tiresome job. In WINDEV, a
SINGLE CLICK allows you to run the test of the window, report or procedure currently created. This
is both simple and fast!
Close the test window: click the system closing button of the window ("x" button found in the
title bar).
The WINDEV editor is redisplayed. Close the code editor: on the "Home" pane, in the "General"
group, click "Close".
An error is displayed in the "Compilation errors" pane. This error indicates that the window
can be resized while no anchoring is defined. Don't worry: This error will be processed in the
next paragraph.

Part 1: Discovering WINDEV 35

 When developing an application, WINDEV indicates the possible problems that
may occur in your application via the "Compilation errors" pane.
This pane presents different types of errors:
• Compilation errors: The errors signal a major problem (programming error, ...).
The project test or execution will not operate.
Notes

• Compilation warning: The warnings signal programming cases that may cause
unexpected behaviors.
• Compilation information: The information explains the compiler choices or
presents tips for improving the code.
• FUI errors: The GUI compilation errors indicate the possible problems detected
in your interfaces: images not found, truncated captions, ...

Window improvements
During this first test, you have noticed that:
• your window is too big,
• your window can be resized while it only contains two controls,
• the first name is displayed with the case used in the edit control. We are going to force the use of
an uppercase letter at the beginning of the word.
We are going to improve the interface of this window.
To reduce the window size in the editor:
1. Click the window: handles appear around the window.
2. Click the handle found at the bottom right and reduce the window size by keeping the left
mouse button down.
To prevent the window from being resized at run time:
1. Double-click the window. The description window is displayed.
2. In the "GUI" tab, uncheck "Resizable" (all you have to do is click the option).
3. Validate.
Notes

Tips for improving the interface and the ergonomics will be presented in a next
chapter.

Run the test of this window to see the result at run time.
Go back to the editor by closing the test window.
We are now going to force the use of an uppercase letter when typing and displaying the first
name.

36 Part 1: Discovering WINDEV

 By default, the characters will be typed in uppercase or lowercase according to
Notes the position of the [CAPSLOCK] key on the keyboard. This type of input can cause
problems when performing a search for example.
WINDEV proposes to manage an input mask for a control. The input mask is used
to automatically format the value typed, without programming.

To modify the input mask:

1. Double-click the "FirstName" control. The description window of the control is displayed.
2. In the "General" tab, expand the "Input mask" list and choose "1st letter in caps".

3. Validate the description window of the control.

4. In the editor, the name of the mask is automatically displayed in the control.
Run the test of this window to see the result at run time

Your first window was successfully created. In the rest of this lesson, we are going to discover new
WINDEV concepts.
Validate the message and close the test window (click the cross in the top right corner of the
window). The editor is redisplayed.
Close the "WIN_Edit" window displayed in the editor: on the "Home" pane, in the "General"
group, click "Close".

Part 1: Discovering WINDEV 37

 An example for each type of control
Two types of controls have been used in this lesson: an edit control and a button.
WINDEV proposes more than fifty controls. Several unit examples are available,
allowing you to discover the use of each type of control.
To open a unit example:
1. Display the home window of WINDEV (press CTRL + <).
2. Click "Open an example" if necessary.
Notes

3. The list of complete examples, training examples and unit examples is

displayed.
4. In the "Unit examples" category, select the requested example ("The
TreeView control" for example) and double-click its name: the corresponding
window is automatically opened in the editor.
Note: To make things easy, all the unit examples corresponding to controls start
with "The control ". You have the ability to type these words in the search control
of the home window.

Close the project: on the "Home" pane, in the "General" group, expand "Close" and select
"Close the project".

WINDEV: Main concepts and terminology

After these exercises, let's talk about the main concepts of WINDEV and about the terminology
specific to WINDEV.

Main concepts
WINDEV allows you to easily create an application. But what is an Application?
An application is a tool used to automatically perform tasks, actions. An application includes an
executable program (or a set of executable programs), libraries, data files, ...
An executable program is a file made of elements that can be directly handled by the user
(windows, printed reports, ...). It is started by the end user of an application.
To create an executable, WINDEV proposes to create a project. A project links and organizes the
different program elements. The executable program will be created from the project.
If your application is using data, WINDEV allows you to define the structure of the database via the
analysis. The WINDEV analysis contains the description of the files (also called "Tables" in several
databases). These files will contain the application data.
Notes

Describing the data files in the analysis does not mean that they are created. The
data files are physically created when running the application.

38 Part 1: Discovering WINDEV

One or more WINDEV projects can be linked to the same analysis. In this case, we talk of shared
analysis. For example, an application for business management can be divided into several
executable modules. Each module is using the same analysis (at run time, each executable can
also use the same data files).

Project 1

Classes Style Windows

sheet and controls

Analysis

Project 2 Project N

Classes Style Windows Classes Style Windows

sheet and controls sheet and controls

Terminology
As already seen, a WINDEV project (linked to an analysis if necessary) is used to create an
application. Before we actually start working with WINDEV, let's go back to the vocabulary used
in WINDEV. Indeed, several terms are specific to WINDEV and they may not have the same
significance as the the ones used in the other tools.
In the analysis, the terms used are as follows:
• File: The analysis is used to describe the structure of the database files. A "File" may
correspond to a "table" in other databases.
In WINDEV, "Table" is a term that defines a graphic object used to view the content of a data file
in table format and/or to enter rows. A table can be used to type the order details for example.
• Record: A record is sometimes called row. A file record corresponds to all the items defined for
the file.

Part 1: Discovering WINDEV 39

 • Item: In the analysis, an item represents a section of a data file. All the items found in a data file
are used to define the structure of a record.
• Key/Index: With WINDEV and its HFSQL database, the concept of index is linked to the concept
of key. The concept of key is part of the characteristics of an item. The keys are used to improve
the speed for accessing data and to simplify the browse operations performed on the data files.
In WINDEV, if a HFSQL data file includes several key items, a single index file will be created at
run time.

In the windows and reports, the terms used are as follows:

• Window: The windows are used to display or enter information. The windows are also called
"Screens" or "Dialog boxes". The user can directly act on the windows via controls, buttons, ...
• Report: The reports are used to get a custom view of information. This information can come
from the database, from text files, from controls found in the windows, ... The reports can be
previewed, printed on paper, generated in PDF or in HTML, ...
• Control: "Control" is the term used to identify the different graphic objects displayed in a window
or in a report.
• Skin template: The skin template is used to define the "appearance" of the application: visual
appearance of windows, buttons, controls, ...
• Style: The style groups the graphic characteristics of an element: background image, border,
font, .... The styles of the different elements found in the interface of a WINDEV application are
grouped in a style sheet.

In an application, the "CustomerName" entity can correspond to:

Important

• the name of a window control

• the name of a report control
• the item of a data file
• a variable defined by the developer

40 Part 1: Discovering WINDEV

 PART 2

The basics of
WLanguage
 42 Part 2: The basics of WLanguage
Lesson 2.1.  The variables

This lesson will teach you the following concepts...

• What is a variable?
• The different types of variables
• The scope of variables
• The String type in details
• The Array type in details

Estimated time: 1 hour

Part 2: The basics of WLanguage 43

 What is a variable?
In a programming language, a variable is used to store data. These memory sections contain
strings, numbers, etc.
The variables are used to perform calculations, to perform comparisons or to store information
that will be used later.

A variable is represented by:

• a name: Name given to the variable so that it can be handled by the language.
• a type: Nature of data stored in the variable (see Types of variables).
• a value: Information stored in the variable.
• a scope: Limit for using the variable in the program (see Scope of variables). The scope is mainly
defined by the location where the variable is declared.

44 Part 2: The basics of WLanguage

Declaring a variable
The variable must be declared (which means created) before it can be used.
• Example of simple declaration:
Price is currency
• Price represents the name of the variable.
• is allows you to declare the variable. The common language is used in WLanguage.
• currency corresponds to the type of variable.
• Example of multiple declaration:
LastName, FirstName are strings
• LastName, FirstName represent the names of variables.
• are allows you to declare a set of variables.
• strings represents the type of variables.

Assignment and use

When the variable is declared, you have the ability to assign it (or to give ti a value).
For example:

// Asssign a currency variable

Price = 1256.67
// Asssign a string variable
LastName = "Doe"

The = operator is used to perform this assignment.

In WLanguage, the " character (double quote) is the character used to delimit a
Notes

character string. In the above example, the doubles quotes are used to assign the
Doe value to the LastName variable.

The content of a variable can be read and handled: all you have to do is use the name given to the
variable in order to access it.
The following example is used to read and display the content of the Price variable on the screen:
Info(Price)

Part 2: The basics of WLanguage 45

 The types of variables
The variable type is used to specify the kind of information that will be stored in the variable. The
most common types are:
• boolean (True or False),
• string ("Doe"),
• integer (1234),
• currency (12.32),
• real (7.766666),
• etc.
Important

Use the type corresponding to the information that must be stored. Therefore,
you will optimize the memory and you will avoid calculation or process errors
when using variables in the WLanguage functions.

Most of these types of variables will be used in this tutorial. See the online help regarding the
relevant type for more details.

Other types are available like the arrays, the structures, the dates, the times, ...
Advanced variables are also available. These advanced types group all the
Notes

characteristics of the element used in a single variable.

Advanced types can be used to handle the XML documents, the emails, the XLS
files, ... This type of variable will be used later in this tutorial.

The scope of variables

The variables can be declared anywhere in the code. However, according to the position of its
declaration, the variable cannot be used to perform processes or calculations. We talk of variable
scope.
Two types of scope are available:
• Global.
• Local.

Global scope
Global means that the variable has an extended visibility in the code. The variable is visible
outside the location where it was declared. Several levels are available:
• Project and Set of procedures,
• Window, Mobile Window, Page, Report.

46 Part 2: The basics of WLanguage

A variable declared at project level has the highest visibility in the program. The variable is visible
anywhere, in all the program processes. However, you should not declare too many variables with
this scope: indeed, the memory occupied by the variable is always reserved even if the variable
is not used. Using an important number of global variables is not recommended in the program
architecture. To pass variables to a process, we recommend that you use parameters (see
“Parameters of a procedure”, page 74 for more details).
A variable declared at Set of Procedures level and a variable declared at project level have the
same visibility. The benefit to declare a variable at Set level is to group (or classify) the variables by
theme in order to make the initialization process of the project more readable.
A variable declared at Window, Mobile Window, Page or Report level limits the scope of the
variable to all the processes of the element (Window, Mobile Window, Page or Report) and its
controls. This is used to encapsulate and limit the uses.

Local scope
Local means that the variable has a limited visibility in the code. The variable is visible in the
process where it was declared. This is used to restrict the use of the variable to the process.

Summary scope diagram

Each level accesses the variables of

higher levels.

Project
Global variables

Global procedures

GUI
(Windows, Pages, Mobile windows, Reports)

Global variables

Local procedures

Processes
Local variables

A variable is global when it is declared:

• in the initialization code of the project (or in the declaration code of the set of procedures). The
variable is global to the project.
• In the declaration code of global variables of the window, page or report. The variable is global to
the element (window, page or report) where it was declared.
In all the other cases, a variable is local to the process where it si declared.

Part 2: The basics of WLanguage 47

 Simple operations on the variables
Several mathematical operators can be used to perform calculations on variables:
• + to perform an addition.
• - to perform a subtraction.
• * to perform a multiplication.
• / to perform a division.

Other operators can be used to perform calculations:

• ++ to increment from 1 (add 1 to the variable).
• - - to decrement from 1 (subtract 1 from the variable).
• += to assign by adding a value.
• += to assign by subtracting a value.
Examples:

// Declaration of variables
Ctr is int
V1 is int
Res is numeric

// Assignment
Ctr = 10
V1 = 3

// Use of operators
Ctr = Ctr + 3 // Ctr is equal to 13
Ctr ++ // Ctr is equal to 14
Ctr -= 8 // Ctr is equal to 6
Ctr = Ctr * V1 // Ctr is equal to 18
Res = Ctr / 5 // Res is equal to 3.6

Comparison operators are also available:

• < less than
• > greater than
• <= less than or equal to
• >= greater than or equal to
• <> different from
• = equal to
Other operators are available. See the online help (keyword: "Operators") for more details.

48 Part 2: The basics of WLanguage

Tips
• It is very convenient to name the variables with long names (and to avoid short names such as
I, j, k, ...). When reading the program again, you will be able to easily find out the purpose of the
variable.
• To define the name of variables, all the Unicode characters (including the accented characters)
are accepted. Meaning improved readability! Caution: some characters are not allowed: space,
=, dot, comma, ...
• It is very important to give the proper type to the variable according to its use. For example, to
store several digits, you may have to:
• use a numeric variable if this variable must be used for calculations.
• use a string variable if this variable must be used to store digits without performing
calculations (to store the social security number for example).

The String variables in details

The String variables are the most often used types of variables.
Let's present in details some features available for this type of variable.

The String type

The String type is used to store and handle the characters and the character strings.
We have already seen how to initialize a string variable:

LastName is string
// Asssign a string variable
LastName = "Doe"

There is no need to declare the length of the string: this length automatically adapts when using
the variable.

To initialize a string variable with a text on several lines, use the following syntax:
<Variable Name> = [
<Text of Line 1>
<Text of Line 2>
]
Tip

For example:
MyString is string
MyString = [
Example of
multi-line string
]

Part 2: The basics of WLanguage 49

 You also have the ability to assign a string variable with the content of a control handling strings.
The following code is used to assign a string variable with the content of an edit control:

LastName is string
// Asssign a string variable
// with the content of the EDT_NAME edit control
LastName = EDT_LastName

In addition to the main comparison operators, several powerful operators are used to manage the
extractions and concatenations in advanced mode.
Some examples:
• " + ": To concatenate strings
• " ~= ": To check the flexible equality
Specific WLanguage functions are used to perform various operations: search, extraction, size,
switch to uppercase characters, ...
Examples:

str is string
str = "WINDEV is a great tool"
// Extract a sub-string from left
Info(Left(str,6)) // Displays "WINDEV"
// Extract a sub-string from right
Info(Right(str,3)) // Displays "ool"

The different WLanguage functions can be nested. A WLanguage function can be

Notes

used as parameter of another WLanguage function.

For example:
Info(Middle(Left(str,13),8,3)) // Displays "is"

See the help about the character strings and about the functions for handling character strings for
more details.

Practical example
To handle the different concepts of this lesson, we are going to create different windows. These
windows will be created in the "WD My first windows" project.
Open (if necessary) the "WD My First Windows" project.
To do so, in the home window, click "Tutorial" and select the first project named "My first
windows (Exercise)".
Tip: if the home window is not displayed, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "My first windows (Exercise)".

50 Part 2: The basics of WLanguage

To handle the Character String variables, we are going to create the following window:

This window is used to:

• find a string inside another one.
• compare two strings.
Create a new blank window:
1. Click among the quick access buttons. The window for creating a new element is displayed:
click "Window" then "Window". The wizard for window creation starts.
2. Select "Blank" and the "Elegant" skin template.
3. Validate. The window is automatically created in the editor. The backup window of the
created element is displayed.
4. Specify the title of the element: "Variables". The element name ("WIN_Variables") is
automatically proposed.
5. Click the green button to validate the information displayed in the backup window.
To create the edit control containing the string:
1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the edit control will be created (at the top, in the middle of the
window for example).
3. Right-click the control and select "Description".
4. In the "General" tab, specify:
• The name of the control: "EDT_Text".
• The caption of the control: "Text".
5. Select the "Content" tab. This tab is used to define the default value of the edit control. Type
"WINDEV is a great tool".
6. Validate the description window. The text typed is directly displayed in the control.
The control content is truncated in the editor. To display the control properly:
1. Select the control.
2. Enlarge the control in width with the sizing handles in order for the content to be entirely
displayed.

Part 2: The basics of WLanguage 51

 Finding a string

To create the "Find a string" button:

1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (below the edit control for example).
3. Click the button that was just created. The text displayed in the button becomes editable.
Type the caption: "Find a string".
4. Press the [ENTER] key to validate the input.
5. Adapt the control size.
6. Display the processes associated with the button ([F2] key).
7. Enter the following click code:

sStringToFind is string = "WINDEV"

nPos is int
nPos = Position(EDT_Text, sStringToFind)
IF nPos = 0 THEN
Info(sStringToFind + " not found in the text")
ELSE
Info(sStringToFind + " found at position "+nPos)
END

Let's study this code:

• Two variables are declared: a String variable corresponding to the sought string and an
Integer variable corresponding to the position of the sought string.
• Position is used to find a string inside another one. In our example, we search for the content
of the sStringToFind variable in the content of the EDT_Text control.
• If Position returns 0, it means that the sought string was not found. A message is displayed
by Info.
Let's now run the window test:
1. Click among the quick access buttons (or press [F9]).
2. The created window is saved and started in execution. Click. The WINDEV word is found.

3. Modify the content of the edit control (by replacing WINDEV by WD for example) and click
the button. The WINDEV word is not found.
4. Close the window.

52 Part 2: The basics of WLanguage

 Comparing two strings

To create the "Compare two strings" button:

1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (on the right of the existing button for
example).
3. Click the button that was just created. The text displayed in the button becomes editable.
Type the caption: "Compare two strings".
4. Press the [ENTER] key to validate the input.
5. Adapt the control size.
6. Display the processes associated with the button ([F2] key).
7. Enter the following click code:
sStringToCompare is string = "WINDEV"

IF EDT_Text ~= sStringToCompare THEN

Info("The text displayed corresponds to "+sStringToCompare)
ELSE
Info("The text displayed does not correspond to "+ ...
sStringToCompare)
END

Let's study this code:

• A String variable is declared. This variable contains the string to compare.
• The ~= operator corresponds to a flexible equality. This operator is used to perform a
comparison while ignoring the case, the spaces found before and after the string and the
accented characters.
• If the comparison is true, the edit control corresponds to the word found in the string to
compare regardless of the case used.
Let's now run the window test:
1. Click among the quick access buttons (or press [F9]).
2. Click the "Compare two strings" button. The message indicates that the comparison is not
correct.

3. In the edit control, type "WINDEV" in uppercase characters and click the "Compare two
strings" button. The WINDEV word is found.
4. Modify the content of the edit control (by replacing “WINDEV” by “windev” in lowercase for
example) and click the button. The WINDEV word is also found.
5. Close the window.

Part 2: The basics of WLanguage 53

 The array variables in details
The arrays are a common type of variable.
An array is a structured type that is used to group a set of elements of the same type. Each array
element can be directly accessed by its subscript.
Specific WLanguage functions are used to handle the arrays and their elements. These functions
start with "Array".

Declaration
The declaration of an Array variable is performed as follows:

<Array Name> is array of <Type of Array Elements>

For example:
arrString is array of strings
arrInteger is array of int

Filling an array and accessing the elements

During its declaration, the array is empty. Add is used to add elements via the following syntax:

Add(<Array Name>, <Element Value>)

To access the array elements, use the following syntax:

<Array Name> [<Element Subscript>]

Important

The subscripts of array elements start from 1.

Example:

// Create an array of strings

MyArray is array of strings
// Add elements
Add(MyArray, "WINDEV")
Add(MyArray, "WEBDEV")
Add(MyArray, "WINDEV Mobile")
// Display the content of the third element
Trace(MyArray[3]) // Displays "WINDEV Mobile"

54 Part 2: The basics of WLanguage

 Fast array initialization
To initialize an array, you also have the ability to use the following syntax:

// Declares an array
arrDay is array of strings
Tip

// Initialization with
// the names of days of the week
arrDay = ["Monday", "Tuesday", "Wednesday",
"Thursday", "Friday", "Saturday", "Sunday"]

See the online help (keyword: "Array") for more details.

Advanced arrays
Advanced arrays are also available: array with several dimensions, array of arrays, associative
array, array of structures, array of objects, ... See the online help (keyword: "Array") for more details.

Part 2: The basics of WLanguage 55

 Lesson 2.2.  The conditional statements

This lesson will teach you the following concepts...

• The IF statement
• The SWITCH statement
• Practical example

Estimated time: 1 hour

56 Part 2: The basics of WLanguage

Overview
WLanguage is a set of statements used to handle data.
The conditional statements are used to compare variables and/or values between themselves in
order to perform different processes. Several conditional statements are available:
• IF... THEN... ELSE... END
• SWITCH...

The IF and SWITCH statements

The IF statement
This statement is used to run an action or another one according to the result of an expression. If
the expression is checked, a process is run; if the expression is not checked, another process can
be started.
The IF statement can be used as follows:

IF <Expression to check> THEN

Process to run if the expression is checked
ELSE
Process to run otherwise
END

Code sample: The following code selects a number at random and displays a message according
to the value.

Tot is currency
// Selects a number at random between 100 and 4000
Tot = Random(100, 4000)
IF Tot>2000 THEN
Info("The amount is greater than 2000")
ELSE
Info("The amount is less than or equal to 2000")
END

In this case, the expression to check corresponds to "Tot>2000".

Note: Several code lines can be run during the process corresponding to a condition. In this case,
the following syntax must be used:

IF <Expression to check> THEN

Code line 1
Code line N
ELSE
Code line 1
Code line N
END

Part 2: The basics of WLanguage 57

 The SWITCH statement
This statement is used to evaluate an expression and to run a process for each possible value of
the expression.
The SWITCH statement can be used as follows:

SWITCH <Expression>
CASE Value 1:
Process 1...
CASE Value 2:
Process 2...
...
CASE Value N:
Process N...

OTHER CASE
Process ...
END

Example: The following code retrieves today's date and displays a different message according to
its value. A specific message is displayed for the 1st and for the 15th of the month. In the other
cases, today's date is displayed.

D is Date
D = Today()
SWITCH D..Day // Checks the day of the date
CASE 1 : Info("Today is the first day of the month")
CASE 15 : Info("Today is the 15th of the month.")
OTHER CASE: Info("Today is: "+ DateToString(D))
END

Notes:
• If the code line "CASE 1:..." is run, the other code lines corresponding to the possible values are
not run.
• Several values can be grouped in the same case. The different values are separated by a
comma. For example:
Sub is int = 2
SWITCH Sub
CASE 1,2: Info("Case 1 or 2")
CASE 3: Info("Case 3")
OTHER CASE: Info("Other case")
END

58 Part 2: The basics of WLanguage

• Several code lines can be run during the process corresponding to an expression value. In this
case, the following syntax must be used:
SWITCH <Expression>
CASE Value 1:
Process 1 - Code line 1...
Process 1 - Code line 2...
CASE Value N:
Process N - Code line 1...
Process N - Code line 2...
OTHER CASE
Process ...
END

Practical example: Using the IF and SWITCH statements

To use the conditional statements, we are going to create the following window:

Two operations are available:

• If the user clicks the check box, the "Close" button is displayed.
• If the user clicks the "Test" button, the box checked in the check box is displayed.

Project used
To handle the different concepts of this lesson, we are going to create different windows. These
windows will be created in the "WD My first windows" project.
Open (if necessary) the "WD My First Windows" project.
To do so, in the home window, click "Tutorial" and select the first project named "My first
windows (Exercise)".
Tip: if the home window is not displayed, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "My first windows (Exercise)".

Part 2: The basics of WLanguage 59

 Creating the window

Create a new blank window:

1. Click among the quick access buttons. The window for creating a new element is displayed:
click "Window" then "Window". The wizard for window creation starts.
2. Select "Blank" and the "Elegant" skin template.
3. Validate. The window is automatically created in the editor. The backup window of the
created element is displayed.
4. Specify the window title: "Conditional statements". The window name ("WIN_Conditional_
statements") is automatically proposed.
5. Click the green button to validate the information displayed in the backup window.

Creating controls in the window for the IF statement

Two controls must be created:
• a Check Box control used to display (or not) the "Close" button.
• a "Close" button used to close the window.
To create the Check Box control:
1. On the "Creation" pane, in the "Usual controls" group, click "Check box" then click the position
where the control will be created in the window (at the top of the window for example).
2. Click the control that was just created: the caption "Option 1" becomes editable.
3. Type the caption of the option: "Make the closing button visible".
4. Press the [ENTER] key to validate the input.
The caption of the option is truncated in the editor. To display the control properly:
1. Select the control.
2. In the popup menu (right mouse click), select "Resize".
3. The control is immediately enlarged and the caption is entirely displayed.
To create the "Close" button:
1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (on the right of the Check Box control for
example).
3. Click the button that was just created. The text displayed in the button becomes editable.
Type the caption: "Close".
4. Press the [ENTER] key to validate the input.
This button is used to close the window. We are going to enter the corresponding WLanguage
code:
1. Select the "Close" button.
2. Press [F2]: the code editor displays the processes associated with the button.
3. Type the following code in the "Click on BTN_Close" process:
Close()

Close is used to close the current window.

60 Part 2: The basics of WLanguage

The "Close" button must be invisible when opening the window. This information corresponds
to its "initial status". We are going to modify this status in the description window of the
control:
1. Select the "Close" button.
2. Display the popup menu of the control and select "Description".
3. In the "GUI" tab, modify the initial status of the control by clicking "Visible". This option is
now unchecked.
4. Validate the description window of the control.
5. The "Close" button is still visible in the editor. Its status was changed in execution only.
6. Save the modifications by clicking among the quick access buttons (on the left of
ribbon) or with the [CTRL] + [S] keys.

IF statement
In our example, a click on the check box must trigger the display of the Close button.
We are going to enter the WLanguage code associated with the check box.
We are going to enter the WLanguage code associated with the check box:
1. Select the Check Box control.
2. Press the [F2] key.
3. Type the following code in the "Whenever modifying CBOX_NoName1" process:

IF CBOX_NoName1=True THEN
BTN_Close..Visible = True
ELSE
BTN_Close..Visible = False
END

Let's study this code:

• CBOX_NoName1 and BTN_Close respectively correspond to the names of Check Box and
Button controls.

To handle the current control in one of the processes associated with it, you have
the ability to use the MySelf keyword.
Tip

In our example, you also have the ability to write:

IF MySelf = True THEN

• The Check Box control is a 2-state control: checked/unchecked. It corresponds in

programming to a Boolean variable. If the control is checked, its value is set to True; if the
control is unchecked, its value is set to False.
• This code checks the value of the check box.
• If the check box is checked, the BTN_Close button becomes visible via the WLanguage
..Visible property.
• If the check box is unchecked, the BTN_Close button becomes invisible.

Part 2: The basics of WLanguage 61

 Several functions and properties are available in WLanguage. The functions can
accept parameters and they return results. The properties are directly applied to
the controls via the following syntax:
Notes

<Control Name>..<Property Name>.

In our example, the ..Visible property is used on the BTN_Close control.
The online help of a function or property can be displayed at any time by pressing
the [F1] key. See for more details ”How to access the online help?”, page 16.

Let's now run the window test:

1. Click among the quick access buttons (or press [F9]).
2. In the window in execution, click the check box. The "Close" button becomes visible.

3. Click the "Close" button: the window is closed and the window editor is displayed.

Creating controls in the window for the SWITCH statement

Two controls must be created:
• a Radio Button control used to select the value to check.
• a Button control used to run the test.
To create the Radio Button control:
1. On the "Creation" pane, in the "Usual controls" group, expand "Radio button" (click the arrow).
The list of Radio Button controls proposed by default is displayed.
2. In the list fo controls, in the "Pre-filled" category, click the first proposed control (with
"Mister").
3. Click in the window to create the control (below the Check Box control created beforehand
for example).
To create the "Test" button:
1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (on the right of the Radio Button control
for example).
3. Click the button that was just created. The text displayed in the button becomes editable.
Type the caption: "Test".
4. Press the [ENTER] key to validate the input.

62 Part 2: The basics of WLanguage

SWITCH statement
In our example, the Test button is used to check the selected value and to display a message.
We are going to enter the WLanguage code associated with the Test button:
1. Select Test button.
2. Press the [F2] key.
3. Type the following code in the "Click on BTN_Test" process:
SWITCH RADIO_Titles

4. When pressing the [ENTER] key to go to the next line, the code editor automatically displays
the different possibilities of SWITCH:

5. Type the following code:

SWITCH RADIO_Titles
// Mr
CASE 1
Info("You've selected Mr")
// Misses
CASE 2
Info("You've selected Mrs")
// Miss
CASE 3
Info("You've selected Miss")
// Other
CASE 4
Info("You've selected Other")
END

Part 2: The basics of WLanguage 63

 Let's study this code:
• RADIO_Titles corresponds to the name of the Radio Button control.
• The Radio Button control is a control proposing several options (4 in our case). A single
option can be checked at a time. The Radio Button control corresponds in programming to
an Integer variable. Each menu option is associated with a value. If this option is checked,
the Radio Button control takes for value the identifier of the checked option.
• This code checks the value of the radio button. A message is displayed according to the
value of the radio button.
Let's now run the window test:
1. Click among the quick access buttons (or press [F9]).
2. In the window whose test is run, select an option and click "Test": the message corresponding
to the selected option is displayed.

3. Close the window.

64 Part 2: The basics of WLanguage

 Lesson 2.3.  The loops

This lesson will teach you the following concepts...

• The FOR statement

• The LOOP statement
• The WHILE statement
• Practical example

Estimated time: 1 hour

Part 2: The basics of WLanguage 65

 Overview
The loop statements are used to run a process in a recurring way. A specific loop statement is
used according to the number of occurrences. Several statements can be used to perform loops:
• FOR...
• LOOP...
• WHILE...

The FOR statement

The FOR statement is used when the number of occurrences to process is known. This statement
is used to manage the number of occurrences via a variable in which the passages performed in
the loop will be counted.
The syntax of the FOR statement is as follows:

FOR Subscript = Start Value TO End Value

Process to run
END

For example, the following code runs the process 2000 times:

FOR nCtr = 1 TO 2000

// Process to run
END

Note: An increment step can be defined for the subscript via the STEP keyword. For example, the
following code runs the process 2000 times and the nCtr variable decreases from 10 to 10:

FOR nCtr = 2000 TO 1 STEP -10

// Process to run
END

The LOOP statement

The LOOP statement is used to perform loops when the number of occurrences to process is not
known. In this case, a test must be used to exit from the loop.

The syntax of the LOOP statement is as follows:

LOOP
Process to run
IF <Expression> THEN BREAK
END

66 Part 2: The basics of WLanguage

For example:

Counter is int
Counter = 10
LOOP
// Process to run
Counter = Counter - 1
IF Counter = 0 THEN BREAK
END

The LOOP statement and the FOR statement can have the same behavior: all you
have to do is use the syntax with exit according to the number of iterations:
LOOP (<Number of Iterations>)
...
Tip

END
Example:
LOOP(10)
// Process to run
END

The WHILE statement

The WHILE statement and the LOOP statement operate according to the same principle. The
difference is that the test of the exit condition is performed BEFORE the execution of the loop
code. This test is used to compare a variable. This variable starts from a start value and it is
modified in the loop until it reaches the value that triggers the exit from the loop.

The syntax of the WHILE statement is as follows:

<Initialie the variable to its start value>
WHILE <Compare the variable to its end value>
Process to run
<Modify the variable>
END

For example:

Counter is int
Counter = 0
WHILE Counter<10
// Process to run
Counter = Counter + 1
END

Part 2: The basics of WLanguage 67

 Practical example: Using loops
To check the use of loops, we are going to create a window into which an Image control will be
moved.

Project used
To handle the different concepts of this lesson, we are going to create different windows. These
windows will be created in the "WD My first windows" project.
Open (if necessary) the "WD My First Windows" project.
To do so, in the home window, click "Tutorial" and select the first project named "My first
windows (Exercise)".
Tip: if the home window is not displayed, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "My first windows (Exercise)".

Creating the window

Create a new blank window:

1. Click among the quick access buttons. The window for creating a new element is displayed:
click "Window" then "Window". The wizard for window creation starts.
2. Select "Blank" and the "Elegant" skin template.
3. Validate. The window is automatically created in the editor. The backup window of the
created element is displayed.
4. Specify the window title: "Loops". The window name ("WIN_Loops") is automatically
proposed.
5. Click the green button to validate the information displayed in the backup window.

Creating the controls

We are going to create the Image control then the buttons used to handle this image.
To create an Image control:
1. On the "Creation" pane, in the "Usual controls" group, click "Image". Position the control in the
window.
2. Right-click the control and select "Description".
3. In the description window, click the "Catalog" button. This button is used to display the
image catalog
4. We are going to associate an image with the tab via the image catalog of WINDEV.

As soon as an image can be displayed in a control or in a window, WINDEV

Notes

proposes to use the image catalog via the "Catalog" button. This catalog contains
hundreds of images, cliparts, ...

68 Part 2: The basics of WLanguage

 5. Type "Animal" in the search area. Click the magnifier to start the search.

6. Select the image and validate (green button).

7. A window used to configure the image is displayed. Keep the default options and validate.
8. The image is displayed in the Image control. Validate.
9. Save the window (CTRL S or click among the quick access buttons).
We are now going to create a button in order for the image to be moved by 300 pixels to the
right in the window. To do so, we will be using the FOR statement of WLanguage.
1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (below the Image control for example).
3. Click the button that was just created. The text displayed in the button becomes editable.
Type the caption: "FOR statement".
4. Press the [ENTER] key to validate the input.
5. Adapt the control size.
6. Display the processes associated with the button ([F2] key).
7. Enter the following click code:
// Moves the image horizontally by 300 pixels
FOR i=1 TO 300
IMG_NoName1..X++
END

This code is used to modify the X coordinate of the Image control (..X property) in a loop from
1 to 300. At each loop turn, the X coordinate is increased by one pixel.

When typing conditional statements in the code editor, the different possible
syntaxes are proposed in a list by the code editor.
Notes

If you select one of these syntaxes, the structure of the statement is automatically
inserted into the code editor. All you have to do is type the code corresponding to
each part of the statement.

Part 2: The basics of WLanguage 69

 Let's now create a button used to move the image until it reaches the right border of the
window. To do so, we will be using the WHILE statement of WLanguage.
1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (on the right of the FOR button for
example).
3. Click the button that was just created. The text displayed in the button becomes editable.
Type the caption: "WHILE statement".
4. Press the [ENTER] key to validate the input.
5. Adapt the control size.
6. Display the processes associated with the button ([F2] key).
7. Enter the following click code:

// Moves the button horizontally up to the border

// of the window
WHILE IMG_NoName1..X < WinInWidth() - IMG_NoName1..Width
IMG_NoName1..X++
END

This code is used to modify the X coordinate of the Image control (..X property) until a
condition is true. In our case, this condition is as follows: the image position (..X property)
must correspond to the window width less the image width.

When a code line is too long to be displayed in the window of the code editor, you
Tip

have the ability to cut it in 2 by using a carriage return.

Let's now create a last button used to move the image until it reaches the left border of the
window. To do so, we will be using the LOOP statement of WLanguage.
1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (on the right of the FOR button for
example).
3. Click the button that was just created. The text displayed in the button becomes editable.
Type the caption: "LOOP statement".
4. Press the [ENTER] key to validate the input.
5. Adapt the control size.
6. Display the processes associated with the button ([F2] key).
7. Enter the following click code:

// Moves the image to the left

LOOP
IMG_NoName1..X--
IF IMG_NoName1..X <= 0 THEN BREAK
END

This code is used to modify the X coordinate of the Image control (..X property). At each turn,
a condition is checked.

70 Part 2: The basics of WLanguage

 If this condition is true, the program exits from the loop. In our case, the condition is as
follows:
• the image position is set to 0,
• the image position is less than 0 (used to manage the case where the user presses the
button several times).

When typing this code, the LOOP statement may be underlined by a green line
and a warning may appear in the pane of compilation errors.
Notes

This warning reminds you that an exit statement must be found in the code of
the loop to avoid an infinite loop.

Window test

Let's now run the window test:

1. Click among the quick access buttons (or press [F9]).
2. The created window is started in execution.
3. Click the different buttons.

4. Close the test window.

Part 2: The basics of WLanguage 71

 Lesson 2.4.  The procedures

This lesson will teach you the following concepts...

• Types of procedures
• Creating and calling a procedure
• Parameters of a procedure
• Result of a procedure
• Practical example

Estimated time: 1 hour

72 Part 2: The basics of WLanguage

Overview
A procedure is used to associate an identifier with a code section in order to re-use it.
In this lesson, we are going to present the different types of procedures available in WLanguage,
their creation mode, how to call them, pass parameters and retrieve a result.

Types of procedures
Three types of procedures are available:
• Global procedure: can be used in all the processes of the project (declared in a set of
procedures).
• Procedure local to a Window, Page or Mobile Window: can be used in all the processes related
to the object where this procedure was declared.
• Procedure internal to a process: can only be used in the process where it was declared.

Scope of procedures
Notes

The procedures comply with the scope rules presented for the variables (see
“The scope of variables”, page 46).

Creating and calling a procedure

Global procedure
To create a global procedure, you must:
1. Create (if necessary) a set of procedures (via the "Project explorer" pane, "Procedures" folder).
Give a name to the set of procedures.
2. Create a global procedure in the set of procedures (via the "Project explorer" pane,
"Procedures, Set name" folder). Give a name to the procedure.
3. Type the code of the global procedure. The procedure code has the following format:

PROCEDURE <Name of Global Procedure>()

Local procedure
To create a local procedure, you must:
1. Select the element associated with the procedure (window, page, ...).
2. Create a local procedure (via the "Project explorer" pane, expand the name of the element,
"Local procedures" folder).
3. Give a name to the procedure.
4. Type the code of the local procedure. The procedure code has the following format:

PROCEDURE <Name of Local Procedure>()

Part 2: The basics of WLanguage 73

 Internal procedure
To create an internal procedure, type the following code in the relevant process:
INTERNAL PROCEDURE <Procedure Name>()
<Code of internal procedure>
END

Calling a procedure
To call a procedure, use the name of the procedure (with the possible parameters that will be
passed to it).

<Procedure Name>(<Parameter 1>, ..., <Parameter N>)

See the online help (keyword: "Procedure") for more details.

Parameters of a procedure

What is a parameter?
A parameter is a value sent to a procedure during the call to the procedure.
The following example is used to call the Multiply10 procedure and to pass in parameter the value
that will be handled in the procedure:

Multiply10(50)

You have the ability to pass from 0 to several values in parameter to a procedure. These values
can have any type (like for the variables).
The parameter is specified in the procedure declaration in the format of a variable. For example,
for the Multiply10 procedure, the code of the procedure is:

PROCEDURE Multiply10(P)
P=P*10

P is the parameter expected by the procedure.

To specify the role of the parameter in the procedure, you have the ability to
Notes

typecast the parameter in the declaration of the procedure.

For example, to use numeric values only, you have the ability to declare:
PROCEDURE Multiply10(P is numeric)

74 Part 2: The basics of WLanguage

In the following example, the Multiplication procedure expects two Integer parameters and returns
the result of the multiplication.
The code of the procedure is as follows:

PROCEDURE Multiplication(Nb1 is int, Nb2 is int)

Result is int
Result = Nb1 * Nb2
RESULT Result

The code used to call the procedure is as follows:

res is int
res = Multiplication(10, 50)
// Res is equal to 500

How to use the parameters?

By default, passing parameters in WLanguage is performed by reference (or by address). The
parameter in the procedure represents (references) the variable passed during the call.
Therefore, when a statement of the procedure modifies the parameter value, the value of the
variable corresponding to this parameter is modified.
Example:
• The code of the procedure is as follows:
PROCEDURE Test_address(P1)
P1 = P1 * 2

• The code used to call the procedure is as follows:

T is int
T = 12 // T is set to 12 before the call
Test_address(T)
// T is set to 24 after the call

To avoid modifying the value of the variable corresponding to the parameter, the parameters
must be passed by value. Passing parameters by value allows you to handle a copy of the
parameter value. If the procedure code modifies the value of the variable, the value of the variable
corresponding to the parameter is not modified.
To force a parameter to be passed by value to a procedure, the LOCAL keyword must be used in
front of the parameter name in the declaration of the procedure. This keyword indicates that the
following parameter will not be modified by the procedure.
Example:
• The code of the procedure is as follows:

PROCEDURE Test_value(LOCAL P1)

// Local indicates that the parameter will be passed by value
P1 = P1 * 2

Part 2: The basics of WLanguage 75

 • The code used to call the procedure is as follows:

T is int
T = 12 // T is set to 12
Test_value(T)
// T does not change

In the same procedure, some parameters can be passed by address while

Notes

other parameters can be passed by value. All you have to do is used the LOCAL
keyword in front of each parameter passed by value.

Mandatory or optional parameters?

The parameters received in the procedure can be mandatory or optional parameters. A mandatory
parameter must be filled during the call to the procedure while an optional parameter can be
omitted: in this case, it will take the default value defined when declaring the procedure
parameters.
Notes

When declaring a procedure, the optional parameters are the last parameters
(they are always specified after all the mandatory parameters).

In the following example, the Multiplication procedure is using an optional parameter, Nb2. This
optional parameter is indicated after the mandatory parameters, by specifying its default value. In
this example, the default value of the optional parameter is set to 10.

PROCEDURE Multiplication(Nb1 is int, Nb2 is int=10)

Result is int
Result = Nb1 * Nb2
RESULT Result

The code used to call the procedure is as follows:

res is int
res = Multiplication(6)
// Res is equal to 60

In this example, the second parameter was not specified. Therefore, its default value will be used.

Result of a procedure
The procedures can return one or more results. The result can be typecasted. The RESULT keyword
must be used to return a value.
See the online help (keyword: "Result") for more details.

76 Part 2: The basics of WLanguage

Practical example: Using a procedure
In a new window, we are now going to:
• Create two numeric edit controls containing the value BT and the value IOT.
• Creating a Combo Box control used to choose the VAT rate.
• Create a button used to calculate and display the value IOT corresponding to the amount BT.
The calculation result will be displayed in the "Price IOT" control.

This window is as follows:

Project used
To handle the different concepts of this lesson, we are going to create different windows. These
windows will be created in the "WD My first windows" project.
Open (if necessary) the "WD My First Windows" project.
To do so, in the home window, click "Tutorial" and select the first project named "My first
windows (Exercise)".
Tip: if the home window is not displayed, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "My first windows (Exercise)".

Implementation

Create a new blank window:

1. Click among the quick access buttons. The window for creating a new element is displayed:
click "Window" then "Window". The wizard for window creation starts.
2. Select "Blank" and the "Elegant" skin template.
3. Validate. The window is automatically created in the editor. The backup window of the
created element is displayed.
4. Specify the window title: "Procedures". The window name ("WIN_Procedures") is
automatically proposed.
5. Click the green button to validate the information displayed in the backup window.
To create the edit control corresponding to the price BT:
1. On the "Creation" pane, in the "Usual controls" group, expand "Edit" (click the arrow). The list
of available edit controls is displayed. Select the "Currency" control and position the control in
the window.
2. Right-click the control and select "Description".
3. In the description window:
• Type the control name: "EDT_PriceBT".
• Type the caption: "Price BT".
4. Validate.

Part 2: The basics of WLanguage 77

 To create the control where the result will be displayed:
1. On the "Creation" pane, in the "Usual controls" group, expand "Edit" (click the arrow). The list
of available edit controls is displayed. Select the "Currency" control and position the control in
the window (below the edit control displaying the price BT for example).
2. Enter the control information: right-click the control and select "Description".
• Specify the control name: "EDT_PriceIOT".
• Modify the caption to "Price IOT".
3. The result displayed in this control must not be modifiable. Click the "GUI" tab and choose
"Read-only" for the initial status.
4. Validate.
5. Save the window.
To create the Combo Box control for VAT selection:
1. On the "Creation" pane, in the "Usual controls" group, click "Combo box" then click the position
where the control will be created in the window (beside the "Price BT" control).
2. The wizard for creating a Combo Box control is displayed. This wizard is used to define the
main characteristics of the control.
3. Select "Fill the combo box by programming or enter a list of values".

4. Display the next screen.

5. Keep the default options. Display the next screen.
6. In the screen named "Initial content", enter the list of possible VAT values:
• 5.5
• Press the [ENTER] key.
• 10
• Press the [ENTER] key.
• 20.

7. Display the next screen: give a name (COMBO_VAT) and a caption (VAT) to the control.

78 Part 2: The basics of WLanguage

 8. Validate.
To create the "Calculate" button:
1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (below the Combo Box control for
example).
3. Click the button that was just created. The text displayed in the button becomes editable.
Type the caption: "Calculate".
4. Press the [ENTER] key to validate the input.
The amount IOT will be calculated in the process of the "Calculate" button.
1. Display the code of the "Calculate" control ("Code" from the popup menu).
2. Type the following code in the "Click on BTN_Calculate" process:
SWITCH COMBO_VAT..DisplayedValue
// 5.5 %
CASE 5.5
EDT_Price_IOT = EDT_Price_BT * 1.055
// 10 %
CASE 10
EDT_Price_IOT = EDT_Price_BT * 1.1
// 20 %
CASE 20
EDT_Price_IOT = EDT_Price_BT * 1.2
END

This code calculates the amount IOT by using the value selected in the Combo Box control
(returned by ..DisplayedValue).

Part 2: The basics of WLanguage 79

 3. Run the test of your window ( among the quick access buttons). Give a price BT. Select
the different values in the Combo Box control and click the "Calculate" button.

Our window operates properly now. However, instead of using a formula 3 times to calculate the
price, a procedure can be used to perform this calculation.
Close the test window to go back to the code editor.
Creating and using a procedure

To create the procedure for calculating the amount IOT:

1. Click the window background.
2. Display the processes associated with the window ([F2] key).
3. In the code editor, on the "Code" pane, in the "Procedures" group, expand "New" and select
"New local procedure".
4. In the window that is displayed, type the name of the local procedure ("Calc_IOT") and
validate ("Add" button).
5. The new procedure local to the window is automatically created and its code is displayed in
the code editor.
6. Type the following code:

PROCEDURE Calc_IOT(PriceBT, VATRate)

cyIOT is currency
cyIOT = PriceBT * (1 + VATRate/100)
RESULT cyIOT

Let's study this code:

• Two parameters are expected by the Calc_IOT procedure: the price before tax and the VAT
rate.
• This procedure declares a currency variable. This variable is used to store the calculated
price IOT.
• This procedure calculates the price IOT and returns the calculated value.
7. Close the code editor.

When creating a procedure, comments are automatically generated BEFORE

the procedure code. These comments are mainly used to specify the content of
Notes

parameters as well as the content of the return value.

It is important to fill these comments. Indeed, they will be automatically displayed
in a tooltip when typing the call to the procedure in the code editor.

80 Part 2: The basics of WLanguage

Let's now call the procedure from the calculation button.
1. Select the "Calculate" button.
2. Display the code of the button ([F2] key for example).
3. Replace the existing code by the following code:
SWITCH COMBO_VAT..DisplayedValue
// 5.5 %
CASE 5.5
EDT_Price_IOT = Calc_IOT(EDT_Price_BT,5.5)
// 10 %
CASE 10
EDT_Price_IOT = Calc_IOT(EDT_Price_BT,10)
// 20 %
CASE 20
EDT_Price_IOT = Calc_IOT(EDT_Price_BT,20)
END

This code calls the Calc_IOT procedure to calculate the amount IOT. Two parameters are
passed in parameter: the price BT and the VAT rate. The result returned by the procedure is
assigned to the EDT_Price_IOT control.
Let's now run the window test:
1. Run the test of your window ( among the quick access buttons). Give a price BT. Select the
different values in the Combo Box control and click the "Calculate" button.
2. The amount IOT is displayed.
3. Close the test window.

Conclusion
This section allowed you to get familiar with the main concepts of WLanguage programming in
WINDEV. Several other features are available. Other ones will be presented later in this tutorial.
WLanguage is a very powerful language that allows you to develop applications that use:
• the Object-Oriented Programming (OOP),
• the MVP (Model View Presenter),
• a 3-tier programming,
• advanced types (XML, Email, ...), ...
See the online help regarding the relevant topic for more details.

Part 2: The basics of WLanguage 81

 Lesson 2.5.  Questions/Answers

This lesson will teach you the following concepts...

• Questions/Answers

Estimated time: 10 min

82 Part 2: The basics of WLanguage

Questions/Answers

Question How to view the element to which the current process belongs?

To view the element corresponding to the current process, on the "Code" pane, in the "Navigation"
group, click "Go to the object" (CTRL + ALT + F2). The window containing the requested element is
displayed.

Question How to print the source code?

To print the current source code, click in the "Home" pane or press [CTRL] + [P].

Question How to perform a “find and/or replace”?

The functions for performing searches or replacements (in the code, in the interface, ...) can be
accessed from the "Home" pane, in the "Find" group or in the "Find - Replace" pane (CTRL + F):

Then, you have the ability to define the different characteristics of the search to perform.

Part 2: The basics of WLanguage 83

 Question What is the meaning of the “+” and “-” signs in the code editor?

The code editor allows you to expand or collapse the WLanguage code. This feature is very useful
if your processes use a lot of structured statements (loops, conditions, browses, ...).
To collapse a code section, on the "Display" pane, expand "Collapse" and select "Collapse all" (or
press [CTRL] + [SHIFT] + * (on the numeric keypad)).
Only the comments remain visible. The associated code is displayed in a tooltip when the comment
line is hovered by the mouse cursor:

Press [CTRL] + * (on the numeric keypad) to expand the entire code. A click performed on the "-" or
"+" symbol allows you to collapse or expand the corresponding code section.

Question Is it possible to identify the person who wrote a code line?

Press [F6] to display information (name and creation/modification date) about each code line.

Question Is it possible to find out the number of a code line?

In the code editor, to enable (or not) the numbering of code lines, on the "Display" pane, in the
"Help for edit" group, click "Display the line numbers" (shortcut: [CTRL]+[SHIFT]+[G]).

84 Part 2: The basics of WLanguage

 Question Is there a method to easily display the syntax or the help about a
function?

When typing a function in the code editor:

• the name of each parameter is displayed in a tooltip for the code line currently in edit. For
the parameter currently in edit, hovering the parameter name with the mouse is used to
display the parameter details in a tooltip.
If several syntaxes are available, press [CTRL] +[ALT] + Right Arrow or [CTRL] + [ALT] + Left
Arrow to go from a syntax to another one.
• the syntax of the function is displayed in the status bar of the editor.
In the help displayed, the parameters enclosed in [ and ] are optional parameters.

For the functions that require names of data files, controls, windows or reports, the assisted input
is used to display the list of project elements corresponding to the parameter of the function
currently typed.
Examples of assisted input for HReadFirst: the <Wizard> option is used to start a code wizard. This
wizard asks you questions regarding the use of the function and it automatically generates the
corresponding code.
A help page is associated with each WLanguage function and property. This help page can be
directly accessed from the code editor: to do so, press [F1] on the name of the requested function
or property.

Question What are the useful shortcuts in the code editor?

• [F2] on the name of a control, class, procedure or report block displays the process of this object.
• [CTRL]+[F2] is used to go back to the initial process.
To move from a process to another one, press [F2] repeatedly. To go back to the initial process,
press [CTRL]+[F2] the same number of times.
• [CTRL]+[L] deletes the current line.
• [CTRL]+[D] duplicates the current line (or the selected lines) on the line below.
• [TAB] and [SHIFT]+[TAB] are used to manage the indent for the selected lines.
• [CTRL]+[/] converts the selected lines into comments, [CTRL]+[SHIFT]+[/] removes the
comments (Caution: [/] key on the numeric keypad).
• [CTRL]+[R] is used to automatically indent the code displayed.

Part 2: The basics of WLanguage 85

 Question How do I communicate with the user?

All you have to do is use an advanced dialog box. These dialog boxes are used to manage:
• the directive questioning (Dialog): the user answers a question via buttons containing the
text of the action to perform.
• the immediate input (Input), by allowing the user to enter the requested value in the dialog
box.
See the online help (keywords: "Dialog" and "Input") for more details.
To check the different modes for communicating with the user:
1. Open (if necessary) the "WD My first windows" project: on the "Home" pane, in the "Online
help" group, expand "Tutorial" and select "My first windows (Answer)".
2. Open the "WIN_Dialog" window. This window presents the different dialog modes.
3. Run the test of this window ("GO" button).
4. Click the different buttons to check the different dialog modes.

5. Stop the test of this window and go back to the code editor to study the code of each button.

86 Part 2: The basics of WLanguage

 PART 3

My first
database
 88 Part 3: My first database
 Lesson 3.1.  Overview

This lesson will teach you the following concepts...

• Overview of the project developed in this part

Part 3: My first database 89

 Overview of the project developed in this part
We are going to create a project associated with a HFSQL database.
This will allow you to discover the main elements for creating an application:
• Creating a WINDEV project.
• Describing the data files used by the application.

In a next section, we will concentrate on the development of the elements (windows, reports, ...)
found in an application with data that will be developed from A to Z, from the interface creation to
the final distribution. You will see the main points for developing an application.
In this section, we are going to create a database used to manage orders.
The same type of database will be used in part 4 of this tutorial to develop a full application. The
database used is HFSQL Classic, the free database supplied with WINDEV. The HFSQL Client/
Server database will be presented later in this tutorial.

90 Part 3: My first database

 Lesson 3.2.  WINDEV and the
databases

This lesson will teach you the following concepts...

• Vocabulary used.
• The different modes for accessing the databases.

Estimated time: 5 min

Part 3: My first database 91

 Overview
You may have to handle data when creating an application. To store the data, you must create a
"database".
In WINDEV, when creating a project that is using data, an "analysis" must be created beforehand.
An analysis contains the description of the data files (or tables) containing the application data.
When running the application, these descriptions will be used to create the database and/or the
data files. The information will be stored in this database or in these data files.
Notes

Several tools for performing maintenance operations on the HFSQL databases

are supplied with WINDEV. They can be accessed from the HFSQL Control Center.

WINDEV can handle most of the database formats (nearly all of them). The most common formats
are:
• HFSQL, the database system supplied with WINDEV. The HFSQL database is available in
Classic mode or in Client/Server mode.
• Oracle, SQL Server, MySQL, xBase, SQL Azure, ...
• AS/400, Access, Sybase, Informix, ...
• Any database accessible in SQL language in Windows.
• Text (ASCII files).
Several methods can be used to access data:
• Native Connector (also called Native Access),
• OLE DB access,
• Direct ODBC access,
• ODBC access via OLE DB.

HFSQL
HFSQL is a database that is very powerful, very fast and very reliable.
HFSQL operates in Windows and Linux, on mobile devices (iOS, Android, Windows CE, Windows
10), on networks of any size and type, and it automatically manages hundreds of concurrent
accesses.
HFSQL can be freely distributed with your WINDEV applications.

HFSQL proposes all the features of a database, especially:

• the log process,
• the transactions,
• the replication,
• the triggers.
See the online help for more details about implementing these features.

92 Part 3: My first database

In the different sections of this tutorial, we will be using a HFSQL Classic database then a HFSQL
Client/Server database.

The different modes for accessing the databases

Native Connector (Native Access)

A Native Connector is using a database format directly and exclusively. This optimized type of
access is developed specifically for each database format.
In WEBDEV, a Native Connector is available for the following databases:
• HFSQL Classic or Client/Server (standard)
• xBase (standard)
• Access (standard)
• XML (standard)
• SQLite (standard)
• Oracle (optional)
• AS/400 (optional)
• SQL Server (optional)
• Sybase (optional)
• Informix (optional)
• DB2 (optional)
• Progress (optional)
• MySQL (optional and free)
• PostgreSQL (optional and free)
• MariaDB (optional and free)
• SQL Azure (optional and free)
Other Native Connectors will be available soon, contact our sales department for more details!
The WLanguage functions SQL* and HRead* can be used with this type of access. The code is
portable and independent of the database.

Part 3: My first database 93

 Direct ODBC access
An access via direct ODBC is using a multi-database access standard. The ODBC layer must be
installed on your computer. In most cases, this layer is already installed in the recent Windows
versions. This can be checked in the control panel of Windows by selecting "ODBC data source" (or
"ODBC administrator" according to the Windows version used).
Caution: some databases may not be accessible via this method. If you want to use this type of
access, check whether an ODBC driver exists and install this driver if necessary.
Only the WLanguage SQL* functions can be used with this type of access.

OLE DB access
An access via OLE DB is an access that is using a multi-database access standard. This type of
access is based on MDAC (Microsoft Data Access Component).
Caution!

If you are using an OLE DB access, MDAC must necessarily be installed on the
user computers (version 2.6 or later).

Some databases may not be accessible via this method. If you want to use this type of access,
check whether an OLE DB driver exists.
The WLanguage SQL* and HRead* functions can be used with this type of access.

ODBC access via OLE DB

In summary, it is a "mix" of OLE DB and ODBC. This is the "heaviest" method and the least efficient
one in term of performance. It should not be used on small databases.
The WLanguage SQL* and HRead* functions can be used with this type of access.

94 Part 3: My first database

 Lesson 3.3.  Project and analysis

This lesson will teach you the following concepts...

• Creating a project
• Creating an analysis

Estimated time: 40 min

Part 3: My first database 95

 Overview
To create an application with database, you must:
• Create the project linked to the application. This project will group all the application elements
(windows, codes, queries, reports, ...).
• Create the analysis linked to the project. The analysis is used to describe all the data files
handled by the application.

This lesson is used to create an application with HFSQL database. As already

seen in the previous lesson, WINDEV allows you to create applications that
handle other databases.
Notes

The lesson “Appendice 2. Using SQL data”, page 452 presents the operations
that must be performed to create a project and an analysis based on an SQL
database (via OLE DB or a Native Connector).

Creating the project

To create the project:

1. Start WINDEV (if not already done). Close the current project if necessary.
2. In the home window, click the "Create a project" button and select "Windows or Linux
application". The wizard for project creation starts. The different wizard screens help you
create your project. The information specified in this wizard can be modified later.

Tip: To create a project, you can also:

Tip

1. Click among the quick access buttons.

2. The window for creating a new element is displayed: click "Project".

3. The first wizard screen is used to enter the name of the project, its location and its
description. In our case, this project will be named "WD My First Database". WINDEV proposes
to create this project in the "\My projects\WD My First Database" directory. You can keep this
location or modify it via the [...] button. For the project summary, type "The purpose of this
project is to manage the customers and their orders".

96 Part 3: My first database

 4. The different wizard steps are specified on the left of the wizard. These steps can be clicked
directly. The other screens in the "Description" step being not fundamental, click "Charters"
directly.
5. This step is used to define the programming charter. Don't modify the suggested options.
Go to the next step via the arrows found at the bottom.
6. This step is used to define the style book. Select "Gensteel". Go to the next step via the
arrows found at the bottom.

7. Click the "Database" step. We are now going to specify the information regarding the
database.
8. Select "Yes, create a new database" and validate. The wizard for analysis creation starts.

Part 3: My first database 97

 To better understand the lessons found in this section and to optimize your
training, we advise you to create the "WD My First Database" project.
Notes

A corrected example can be accessed at any time to check the validity of the
operations performed.
To open this corrected project, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "My first database (Answer)".

Creating the analysis

The wizard steps for analysis creation are as follows:

1. Specify the analysis name and directory. By default, the analysis name corresponds to the
project name and the analysis directory is a ".ana" directory in the project directory. We will keep
these default parameters. Go to the next wizard step.

2. You now have the ability to choose the types of databases used by the project. Select
HFSQL Classic (the database proposed by default with WINDEV).

Go to the next wizard step.

3. Validate. The wizard for creating a data file is automatically started.

98 Part 3: My first database

Creating the description of data files
Our application for managing customers and orders will be associated with the following analysis.
This analysis includes five different data files (tables):
• Customer
• Orders
• PaymentMode
• OrderLine
• Product

To create the data files of this analysis, we will be using the different methods proposed by
WINDEV.

Part 3: My first database 99

 Creating a data file: using a preset file

The wizard steps for creating a data file are as follows:

1. In the wizard, select "Select a description among the preset data files". Go to the next wizard
step (arrow at the bottom of wizard).

2. The list of preset data files is displayed. We are going to create the "Customer" file. In the
list of data files, select "Customer". Go to the next step.
3. The wizard proposes the list of items that will be included in Customer file. This list is very
impressive because it is used to manage several types of Customer files.

4. Check the following items: CustomerID, Company, LastName, FirstName, Address, ZipCode,
City, StateDep, Country, Phone, Cell, Email.
5. Validate the wizard.

100 Part 3: My first database

 6. The "Customer" file is automatically created in the data model editor.

7. The window for creating a new element is displayed. We are now going to create the data file
containing the orders.

Creating a data file: creating the file and items

To create a data file from the window for creating a new element:
1. Click "Data" then "Data file".
Notes

You also have the ability to create a data file from the data model editor: on the
"Analysis" pane, in the "Creation" group, click "New file".

2. The wizard for creating a new data file starts.

3. In the wizard, select "Create a new description of data file".

4. Go to the next wizard step.

Part 3: My first database 101

 5. We are going to create the "Orders" file. Type its name ("Orders") in the wizard.
This name will be used:
• to handle the data file by programming. The variable associated with the file will be "Orders".
• to build the name of the associated physical data file ("Orders.fic" file).
The caption and description of the elements represented by the file records are
automatically displayed.

In the wizard, the control "A record represents" is used to get an understandable
caption during the description of links between data files. A caption is
Notes

automatically proposed from the name of the file.

In our case, type "An order".

6. In the "Automatic identifier" area, keep "Automatic identifier on 8 bytes". If an automatic
identifier is defined on the data file, it means that the data file includes a unique key,
automatically managed by WINDEV.
To create the identifier (an identifier is a unique key), you have the ability to
create a numeric item whose type is "Automatic identifier".
Notes

This identifier is automatically managed by WINDEV. Whenever a record is added

into the data file, WINDEV automatically assigns a value to the file identifier. This
value is unique.

7. Go to the next step and select the type of database associated with the data file. We are
going to work on HFSQL Classic data files. Go to the next step.
8. Click the green button to validate. The data file is automatically created in the analysis. The
description window of items is opened.

102 Part 3: My first database

We are going to create the items of the "Orders" file. In the description window of the data file, you
will notice that an item was automatically created: "OrdersID". This item corresponds to the
automatic identifier of the data file. This item includes the "ID" letters and the file name.
We are going to create the other items of this data file.
First, we are going to create the "Date" item. This item will contain the order date
1. In the description window of items, double-click in the "Name" column of the first empty row.
This column automatically becomes editable. Type "Date".
2. Click the "Caption" column. The name of the item is automatically displayed. We are going
to modify the caption of the item by clicking on it: type "Order date". In the "Type" column, the
"Text" type is automatically selected. Expand the list and select the "Date" type.

3. This item will be a key item (an index) in our data file: the keys are used to improve the
speed for accessing the data and for the sorts.
• For a database in SQL format, the engine is using the indexes at the best.
• For a sequential browse of a data file, all you have to do is specify the browse index (which
means the key).

The concept of key is part of the characteristics of an item. When creating an

item, you have the ability to specify whether it is:
• not key,
Notes

• unique key: the value of this key will be unique in the entire data file (which
means in all the records found in the data file)
• key with duplicates: the value of this key can be found several times in the data
file.

Part 3: My first database 103

 4. The definition of the key is performed as follows: re-select the line of the "Date" item to
enable the description controls found on the right of the screen. Then, all you have to do is
specify the type of key used. In our case, the date is a key with duplicates.

5. You must also define the search direction of the key. The search direction is used to define
the default sort for this item. In our case, when a browse is performed on this key, the default
sort order will be "ascending".
We are now going to create the "Status" item that is used to find out the status of the order.
1. Position on a new table row. Enter:
• the name: Status
• the caption: Status of the order
• the type: Radio button, List box, Combo box. In the window that is opened, you have the
ability to select the type of control created by default for this item. It will be a radio button in
this case. Validate the window.
2. In the lower section of the screen, click the double arrow to display the parameters of the
control linked to the selected item.

The information entered here will be automatically used when creating the windows linked to
the data file. You find here the control type and the caption.
We are going to enter the following options in the "Content" tab:
• Click the "Content" tab.
• Click the "+" button to add the first option.
• The option 1 corresponds to Pending. Type "Pending" in the edit control found on the right.

104 Part 3: My first database

 • Click the "+" button to add the second option.
• Type "Validated" instead of "Option 2".
• Click the "+" button again.
• Type "Canceled" instead of "Option 3".

3. Click the double arrow again.

4. Similarly:
• Position on a new table row and create the "TotalBT" item. This item is a "Currency" item.
• Position on a new table row and create the "TotalIOT" item. This item is a "Currency" item.
5. That's it, the description of the "Orders" file is over. Validate the description window of items.
6. The "Orders" file appears in the data model editor. You have the ability to enlarge the file
displayed. To do so, click the file, select the black handle at the bottom of the file and move
the mouse toward the bottom.

Part 3: My first database 105

 Importing a CSV file
Another method will be used to create the "PaymentMode" file that contains the characteristics of
the payment: importing a CSV file.

A CSV file is a text file that is using a specific format. This file contains data on
Notes

each line. The data is separated by a separation character (a comma, a semi-

colon or a tabulation).

From the CSV file containing the data, WINDEV will create:
• the description of the data file in the analysis,
• the HFSQL data file with the data found in the CSV file.

To import a CSV file into the analysis:

1. On the "Analysis" pane, in the "Creation" group, expand "Import" and select "Import the
descriptions of files/tables".

To import a CSV file (or any other file) into the analysis, you also have the ability
Tip

to Drag and Drop the CSV file (from the Windows file explorer) to the data model
editor. This will be presented in the next paragraph.

2. The wizard for importing files starts.

3. Go to the next step.
4. Select the format of the files to import. In this case, select "Text file". Go to the next wizard
step.

106 Part 3: My first database

 5. Specify the path of the file to import: "\Tutorial\Exercises\WD My First Database\
PaymentMode.csv" found in the setup directory of WINDEV.
6. Go to the next wizard step.
7. Specify the following import parameters:
• Records delimited by: "<Carriage return/Line feed>
• Columns delimited by: "<Semicolon>"
• Strings delimited by: "<None>"
• Decimal separator: "<Automatic: dot or comma>"

8. Don't forget to check "The first row contains the names of the columns".
9. Go to the next step.
10. The structure of the data file that will be created is displayed. Keep the default options. Go
to the next step.

Part 3: My first database 107

 11. The content of the CSV file will be automatically converted to HFSQL format. The wizard
proposes to create the HFSQL file in the project directory. Keep the proposed options and go
to the next step.

12. Validate the wizard. WINDEV creates the data file.

Let's study the description of the imported data file:
1. Select the "PaymentMode" file.
2. In the popup menu (right mouse click), select "Description of data file".
3. In the window that is displayed, modify the caption of the file: delete "(Imported)".
4. Click to display the description of the items found in the data file.
5. This data file contains no automatic identifier and no unique key. We are going to switch the
"Code" item to unique key:
• Position the selection bar on the code item if necessary.
• In the right section of the screen, click "Unique key".

6. We get the following data:

7. Validate the description window of items then the description window of the file.

108 Part 3: My first database

Direct import of existing data files
The last method for creating data files consists in importing the existing HFSQL data files. This
method will be used to create the "Product" file.

To import HFSQL data files:

1. In the file explorer of Windows, open the following WINDEV sub-directory:
"\Tutorial\Exercises\WD My First Database".
2. Select the "Product.fic" file.
3. Drag and Drop the "Product" file to the data model editor of WINDEV.
4. The import wizard starts. Validate the different screens. The data file appears in the data
model editor.
All the necessary data files are now found in the data model editor.

Only the description of the "Product" file was imported into the analysis of our
project. The data found in the "Product" file was not imported into the project.
To handle the data found in the file that was just imported, in the file explorer,
Caution!

copy the "Product.fic", "Product.mmo" and "Product.ndx" files (found in the "\
Tutorial\Exercises\WD My First Database" directory) to the EXE sub-directory of
the project directory.
Note: To directly open the file explorer on the directory of your project, on the
"Home" pane, in the "General" group, click .

Creating links
All the file descriptions required by the application for account management have been created.

Part 3: My first database 109

 We are now going to create the links between data files. A link is used to define the integrity
constraints (cardinalities) between two data files.
Let's create the link between the "Customer" file and the "Orders" file: a customer can have
one or more orders, and each order is linked to a customer.
1. On the "Analysis" pane (found in the ribbon), in the "Creation" group, click "New link". The
mouse cursor turns into a pen.
2. Click the "Customer" file then the "Orders" file.
3. The wizard for link creation starts.
4. Answer the questions asked by the wizard:

• Each Customer has at least one Order: No

• Each Customer can have several Orders: Yes
• Each Order has at least one Customer: Yes
• Each Order can have several Customers: No

You also have the ability to directly enter the cardinalities of the link in the wizard.
Notes

110 Part 3: My first database

 5. Go to the next step. The wizard automatically proposes the key used by the link (CustomerID).

6. Display the next wizard screen. The wizard proposes to create the "CustomerID" key in the
Orders file to store the customer corresponding to the order.

7. Accept this option by going to the next screen.

8. This screen is used to define the integrity rules that will be automatically applied. In our
case, you have the ability to choose the requested behavior when deleting a customer as well
as the requested behavior when modifying the customer identifier.
9. Validate the integrity rules by going to the next screen.
10. Click the green arrow. The link is automatically created in the data model editor.
Similarly, create a link between the PaymentMode file and the Orders file. These two files are
linked as follows:
• An order must have a payment mode.
• A payment mode can be used in several orders.
In the wizard:
• The cardinalities are as follows: PaymentMode (0,n), Orders (1,1)
• The link key corresponds to the "Code" item.

Part 3: My first database 111

 We are now going to create a link between the "Product" file and the "Orders" file. This link will
be used to create a link file, the file of order lines.
1. Similarly, create the link between the files.
2. Answer the questions asked by the wizard:
• Each Product has at least one Order: No
• Each Product can have several Orders: Yes
• Each Order has at least one Product: No
• Each Order can have several Products: Yes

3. Go to the next step. The wizard proposes to create a relation file. Keep "Create the relation
file automatically" and go to the next step.
4. The wizard proposes the unique key of the Product file. Select "Reference". Go to the next
step.
5. Validate the creation of the key by going to the next screen.
6. Keep the default options regarding the integrity rules and go to the next step.
7. The wizard proposes the unique key of the Orders file "OrdersID." Go to the next step.
8. Validate the creation of the key by going to the next screen.
9. Keep the default options regarding the integrity rules and go to the next step.
10. Click the green arrow. The relation file is automatically created in the data model editor.

112 Part 3: My first database

We are now going to modify the relation file that was created by WINDEV. Indeed, this file will
contain the order lines. We are going to:
• Modify the name of the file.
• Modify the name of its items.
• Add items to find out the quantity of products ordered and the total of the order line.
First, we are going to rename the file. A similar operation was already performed when the
caption of the imported file was modified. However, it is a little bit more complex in this case:
we are also going to rename the physical file linked to the file description.
1. Select the "Product_Orders" file.
2. In the popup menu (right mouse click), select "Description of data file".

Part 3: My first database 113

 3. In the window that is displayed, modify:
• the name of the file: "OrderLine".
• the name on disk: "OrderLine".

We are now going to modify the items of this relation file.
1. Click to display the description of the items found in the data file.

2. This file includes 3 items. Position the selection bar on the "Reference_OrdersID" item. This
item is a composite key.

A composite key is a set of items that constitute an index.

Notes

This type of key is used to browse the data file according to complex criteria or to
perform specific searches on several items at the same time.

3. To rename this item:

• Click the "Name" column.
• Replace "Reference_OrdersID" by "OrderLineID".
• Click the "Caption" column.
• Replace the current caption by "Identifier of OrderLine".

114 Part 3: My first database

We are now going to add 3 new items into this relation file: Quantity, TotalIOT and TotalBT.
1. Position on a new row and create the "Quantity" item. This item is a "Numeric" item.
2. Position on a new table row and create the "TotalIOT" item. This item is a "Currency" item.
3. A window is displayed, indicating that the item already exists in the analysis and proposing
to re-use its characteristics:

Keep the options selected by default and validate (green button).

4. Position on a new table row and create the "TotalBT" item. This item is a "Currency" item.
Once again, use the existing description.
5. The description of items for the "OrderLine" file is as follows.

6. Validate the description of items (green button at the bottom of the screen) and the
description of the file.

Part 3: My first database 115

 The analysis is as follows:

Generating the analysis

Generating the analysis consists in validating the modifications performed in the analysis (creation
of data files, addition or deletion of items, ...) and to apply them to the entire project (pages, linked
controls, reports, ...)

The generation is automatically proposed when closing the data model editor while the
modifications have been performed.
You also have the ability to generate the analysis manually. That's what we are going to do.
To generate the analysis:
1. In the data model editor, on the "Analysis" pane, in the "Analysis" group, click "Generation".
2. The generation of the analysis is automatically started.
The descriptions of the data files found in the analysis have been modified.
To update the data files of the application, WINDEV automatically starts the procedure for
modifying the data files. This operation is used to update the data files (".fic" files) according to
their description in the analysis.

116 Part 3: My first database

The wizard for automatic modification starts. Validate the different screens until you reach
the screen that lists the files to take into account.
• WINDEV detects that the PaymentMode file must be updated. Keep this file selected.
• WINDEV detects an ambiguity on the Product file that was copied and imported. Select this
file.

• Go to the next step.

• The wizard proposes to save the existing data files, don't change anything and go to the next
step.
• The wizard proposes to type the passwords for protecting the data files modified by the
automatic modification. Keep the default options and go to the next step.
• The list of data files to modify is displayed. Validate the wizard.
• The data files are updated.
Close the data model editor.
The main steps for creating an analysis have been presented.

When your analysis is described and generated, you also have the ability to:
• Create a full application by RAD (Rapid Application Development). The application corresponding
to the analysis will be created according to this method in the next lesson.
• Create a full custom application. This method will be used to develop a full application based on
a database in part 4 of this tutorial. This application will be based on an analysis corresponding
to the one that was created in this part.

Part 3: My first database 117

 Lesson 3.4.  The full RAD

This lesson will teach you the following concepts...

• What is RAD?
• Generating RAD
• Project test

Estimated time: 20 min

118 Part 3: My first database

What is RAD?
R.A.D. stands for "Rapid Application Development".
The RAD is used to automatically build an application, which means all the necessary windows,
reports and queries.
As already seen, to develop an application in WINDEV, you must create a project and an analysis
(if necessary). The analysis contains the definition of the structures of data files used in the
processes.
The RAD module of WINDEV is based on this analysis. The RAD module includes a wizard allowing
you to choose the application template to generate (the RAD pattern) and the main options
regarding the operating mode of your application.

WINDEV is supplied with several "RAD patterns" allowing you to generate several
Note

application templates. You also have the ability to create your own RAD patterns.
See the online help (keyword: "RAD pattern") for more details.

The windows, the reports, the queries and the code generated by RAD can be customized. You
also have the ability to modify the types of controls, the default values, ...
The RAD can also be used to generate several types of windows, it is the window RAD. The Window
RAD is available when a new window is created in your application.
Let's see how to use the Project RAD module.

RID (Rapid Interface Design)

WINDEV also allows you to generate windows containing the controls linked to
Note

the analysis items only. The code required for these windows to operate must be
written by the developer.
See the online help (keyword: "RID") for more details.

Part 3: My first database 119

 Generating RAD

To start generating RAD:

1. On the "Project" pane, in the "Generation" group, click "Full Application RAD". The wizard for
generating the RAD application starts.

2. Select the pattern that will be used for the RAD generation: "Simple RAD" for example. Go to
the next wizard step.
3. All the data files found in the analysis will be taken into account:

4. Display the next screen.

120 Part 3: My first database

 5. The entry points of the application correspond to the entries available in the menu.

Keep the Customer, Orders, PaymentMode and Product files only. Display the next screen.
6. Specify whether the Table controls generated in the application windows must be allow the
input or not. In our example, the Table controls will allow the user to enter new information.
Select "Yes: Allow the input in the Table controls...". Display the next screen.
7. Specify whether the user groupware must be used in the application. It will be presented
later in this tutorial. Select "No: Don't include the management of user groupware". Go to the
next step.

Part 3: My first database 121

 8. Specify whether the automatic menu must be included in the application. Answer "Yes:
Include the menu '?'".

9. Go to the next step. The wizard for RAD generation is ended and the wizard for generating
the automatic menu starts.

The automatic menu is a help menu suited for your applications. This menu
Note

allows the users of your applications to easily access several features.

The different options proposed by the wizard for generating the automatic menu are as
follows:

122 Part 3: My first database

 1. Keep "Help for AAF (Automatic Application Features)".
2. End the wizard.

When creating the menu '?', the option "? .. Help for AAF (Automatic Application
Features)" has automatically added into your application:
Notes

• the "CCMenu" component. Indeed, this option is using a procedure of this

component to operate.
• the "WINDEV AAF 22.PDF" file. This file will be automatically opened when
using the menu option.

The application is generated and its test can be run.

GUI errors may appear in the Compilation Errors pane. These errors signal
Notes

interface problems, especially in the reports (captions too long for example). To
correct these errors, the reports must be modified.

Application test
Let's now run the test of the generated application.
To run the application test:
1. Click among the quick access buttons. The application starts.
2. In the menu, select "Customers/Prospects .. List of Customers/Prospects".
3. The list of customers is displayed.
4. To add a new person, click the "New" button. An input form is displayed.

Part 3: My first database 123

 5. Enter information about a customer and validate.
6. Close the list of persons.
7. In the menu, select "Product .. List of products". The list of products is displayed.
8. Close the test window. The WINDEV editor is redisplayed.

124 Part 3: My first database

 PART 4

Full application
with data
 126 Part 4: Full application with data
 Lesson 4.1.  Overview

This lesson will teach you the following concepts...

• Overview of the application created in this section

Estimated time: 5 min

Part 4: Full application with data 127

 Overview of the application created in this section
In this section, we are going to create an application that handles data files in HFSQL Classic
format.
This application for order management will be used to:
• View, enter and modify products,
• Print reports,
• Display statistics,
• Manage use levels,
• Send emails,
• ...
The development of this application will allow us to present the deployment and the distribution of
the application to the end users.
You will see the main points for developing an application.

Projects supplied

Example project
The creation of the project and analysis was presented in the previous section. We won't go back
to it. We are going to work with a project that already contains an analysis and pre-filled data
files. The analysis of the application is an improved version of the analysis that was created in the
previous section.
To open this project in WINDEV:
1. Close (if necessary) the current project in order to display the home window.
2. In the home window, click "Tutorial" and select the project named "Full application
(Exercise)".

Before we start developing the application, let's take a look at the analysis associated with the
"WD Full application" project.

128 Part 4: Full application with data

To display the analysis linked to the project, click among the quick access buttons. The
data model editor is displayed:

This analysis contains the description of 5 data files:

• Customer,
• Orders,
• OrderLine,
• Product,
• PaymentMode.
This analysis is straightforward and it is used to manage orders.
Close the data model editor (click the cross at the top right of the menu).

Part 4: Full application with data 129

 Corrected projects
You hesitate about the result to get? Or you don't have time to perform all the operations? A
corrected project is available for the application.
The application that we are going to create being quite long (it is a full application that will allow
you to discover the main features of WINDEV), two corrected projects are available:
• A corrected project corresponding to lessons 4.2 to 4.4. This project contains all the windows
created in these lessons.
To use this corrected project:
1. Close (if necessary) the current project in order to display the home window.
2. In the home window, click "Tutorial" and select the project named "Full application (With
windows)".
• A corrected project corresponding to lessons 4.5 to 4.9. This project contains the entire
application.
To use this corrected project:
1. Close (if necessary) the current project in order to display the home window.
2. In the home window, click "Tutorial" and select the project named "Full application (Answer)".

130 Part 4: Full application with data

 Lesson 4.2.  Addition and
modification windows

This lesson will teach you the following concepts...

• Creating a menu window used to list the products.

• Creating a product form.
• Managing the addition and modification of a product

Estimated time: 50 min

Part 4: Full application with data 131

 Overview
We are going to create the different windows used to list, add and modify products. These
operations will allow you to discover several topics regarding the management of data files and
they will also allow you to use some of the WINDEV features.

If the "WD Full Application" project was not opened in the previous lesson:
1. Close (if necessary) the current project in order to display the home window.
2. In the home window, click "Tutorial" and select the project named "Full application
(Exercise)".
Tip: if the home window is not displayed, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "Full application (Exercise)".

A corrected project is available. This project contains the different windows

Answer

created in this lesson. To open the corrected project, on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (With
windows)".

Creating a window used to list the products

To create the window used to list the products, we are going to create a blank window then add all
the controls: this will allow us to present all the steps required to create this type of window.

Creating the window

To create a window used to list the products:

1. Create a new blank window.
• Click among the quick access buttons (or use the CTRL N shortcut).
• The window for creating a new element is displayed: click "Window" then "Window".
• In the wizard, click the "Based on a template" tab and choose "Use: WINTPL_Template".
Validate.

132 Part 4: Full application with data

 The window templates
A window template is used to give a standard style to the different application
windows.
A window template contains all the graphic elements common to all the
application windows. A window template can also contain code. In this case, this
Notes

code will also be common to all the application window.

The window template named WINTPL_Template was created for this example.
This template contains a logo that will be displayed in all the windows:

2. The new window is displayed in the editor. The backup window of the created element is
displayed.
3. In this window, specify the window title: "Menu".

4. The window name (that will be used in programming) is automatically deduced from the
window title. If this name does not suit you, you have the ability to modify it and to specify a
title that differs from the window name.
5. Validate.
Notes

This window was named "Menu" because it is the main window of our application.
It will be used as menu but it will also display information.

Part 4: Full application with data 133

 Creating the controls
A Table control will be used to create the list of products. This control will be linked to the "Product"
data file.

What is a Table control?

Do not confuse "Table" and "Table control".
We talk of Table for a SQL database.
A Table control is used to view data in a table. In this case, the data can be typed
or it can come from a data file (or from a table).
Notes

The Table control of WINDEV is used to view or modify data:

• in memory: we talk of memory Table control or Table control filled by
programming.
• coming from data files or queries: we talk of browsing Table control.
• coming from WLanguage variables: we talk of Table control on source.

To create the Table control:

1. On the "Creation" pane, in the "Data" group, expand "Table and list box" and select "Table
(Vertical)". The control currently created follows the move of the mouse.
2. Click in the window: the wizard for creating the Table control starts.
3. The Table control that is currently created must display the records found in the "Product"
data file. In the wizard, select "Display the data found in a file or in an existing query". Go to the
next step by clicking the arrow at the bottom of the wizard.

134 Part 4: Full application with data

 4. The next wizard screen proposes the different data files and queries found in the current
project. Expand "Analysis" if necessary and select the "Product" file. Go to the next step.

5. The wizard proposes the list of items found in the "Product" file. By default, all the items are
checked in order to be displayed in the Table control. In our case, we are going to display all
the items EXCEPT for the "ProductID" identifier that corresponds to the automatic identifier of
the data file.

Uncheck "ProductID" and go to the next step.

6. Then, the wizard proposes to select the sort item. This item will be used to sort the data
displayed in the Table control. The items proposed in the wizard correspond to the items
defined as key items in the analysis. The products will be sorted according to their caption.

Click the "Caption" line and go to the next step.

Part 4: Full application with data 135

 7. The following steps correspond to additional parameters. Keep the default options until you
reach the end of the wizard and validate.
8. The Table control is automatically created in the window. The control is automatically
positioned and enlarged in order to occupy the entire available space in the window.

Let's take a look at the control that was just created: the data is already displayed in the control,
even in the editor. This concept is called "Live data": the content of the data files found on the
development computer is used in the windows or reports handled in the editor. This feature is very
useful to define the size of controls found in a window for example.

Window test

We are now going to run the test of the window that was just created.
1. Click among the quick access buttons.
2. The window is automatically displayed with its data at run time.
3. You have the ability to scroll the products with the scrollbar (or with the keyboard arrows).

136 Part 4: Full application with data

Let's imagine that we are the end user to see the possibilities of the Table control at run time.

Some remarks:
• First of all, the Table control has the same aspect at run time and in the editor: this notion is
called WYSIWYG ("What You See Is What You Get").
• Small pictos appear at the top of columns:
• the double arrow indicates that the column can be sorted ("Reference" or "Caption" column
for example).

For example, click twice the "Caption" column: the data is displayed according to a
different order. An arrow on the left of the columns indicates that the column is sorted as
well as the sort direction.
• the magnifier indicates that a search can be performed in the column.

Part 4: Full application with data 137

 Click the magnifier of the "Reference" column for example. An input area is displayed,
allowing you to type the sought reference. Type "REF-010". The product corresponding to this
reference is automatically displayed.

• A popup menu is available for the Table control and for each one of its columns. This popup
menu can be displayed:
• via a right mouse click on the column of the Table control.
• via a click on the arrow found at the extremity of column headers.
This popup menu is used for example to export the content of the Table control in Excel
format, to print, ...

In just a few minutes, we have presented some of the features that are automatically included in
the Table control. No programming is required to propose these features to your users. These
features are called "AAF" (Automatic Application Features).

138 Part 4: Full application with data

 Several controls propose default AAFs. If these features must not be proposed
Notes (for security or confidentiality reasons), they can be disabled in the editor or by
programming. See the online help (keyword: "Automatic Application Features")
for more details.

Now that the list of products is displayed, you may want to modify a product. To do so, we are going
to create a window used to display the product details.
Close the window via the cross found at the top of the screen. The WINDEV editor is
redisplayed.

Creating a "Product form" window

Creating the window

To create a window used to display the product details:

1. Open the "WD Full Application" project if necessary.
2. Create a new blank window.
• Click among the quick access buttons.
• The window for creating a new element is displayed: click "Window" then "Window".
• The wizard for window creation starts.
• In the "Based on a template" tab, choose "Use: WINTPL_Template" and validate the wizard.
3. The backup window is displayed. Type the title of the "Product form" window: "WIN_Product_
form" is automatically proposed.
4. Validate the backup window.

Creating edit controls

We are going to create a window used to display the characteristics of the product selected in the
Table control. This type of window is called a "Form" because it corresponds to a descriptive form
of the requested element.
In our case, this window will be used to display the content of the different items found in the
"Product" data file.
To create the controls in the window:
1. Display the "Analysis" pane if necessary: on the "Home" pane, in the "Environment" group,
expand "Panes" and select "Analysis". The different data files described in the "WD Full
Application" analysis appear in the pane.
2. Click on the left of "Product" file: the items found in the data file are listed.

Part 4: Full application with data 139

 3. With the mouse, select all the items displayed in the pane (except for the "ProductID" item).
You have the ability to use the multi-selection by keeping the [CTRL] key down.
4. Drag and Drop these items to the window that was just created.

5. Different controls are automatically created in the window. These controls are
automatically linked to the corresponding item in the data file. To check this:
• Select the "Reference" control for example.
• Display the popup menu (right mouse click) and select "Description".

140 Part 4: Full application with data

 • Display the "Link" tab of the description window:

This tab shows that the current edit control is linked to the "Reference" item found in the
"Product" data file.
6. Close the description window.
7. Save the window.
Reposition the controls in the window and resize the window in order to get the following
interface:

Part 4: Full application with data 141

 Creating buttons
The "WIN_Product_form" window will be used to add a new product or to modify a product found
in the list.
We are going to add a validation button and a cancelation button.
To create the "Validate" button:
1. On the "Creation" pane, in the "Usual controls" group, expand "Button" (click the arrow found
below ).
2. The list of preset buttons is displayed.
3. Click "Validate": the shape of the button appears under the mouse.
4. Then, click on the right of edit controls to create the button.
Add the "Cancel" button according to the same method.
1. On the "Creation" pane, in the "Usual controls" group, expand "Button" (click the arrow found
below ).
2. In the list of preset buttons, click "Cancel": the shape of the button appears under the
mouse.
3. Then, click below the "Validate" button to create the button.

Improving the interface of the window

This window being quite simple, let's try to improve its interface. Several details can become very
annoying for the user so let's try to sort them out right now.

Aligning controls

One of the first optimizations consists in aligning the controls and in giving them the same
size:
1. Select the "Caption" control then all the edit controls found in the window (keep the [CTRL] key
down while clicking the different controls for example). The first selected control will be used as
reference for the size of the other controls.
2. In the ribbon, display the "Alignment" pane of WINDEV. This pane contains all the alignment
options available for the controls.

142 Part 4: Full application with data

 3. We want the outside and inside borders of controls to be aligned. Click "Justify (Ins. and
Out.)".

If you don't known which alignment to choose, hover the different options
proposed by the "Alignment" pane of WINDEV. When an hovering option with the
mouse cursor, the controls selected in the window are automatically positioned
Notes

and/or resized according to the hovered option.

If the positioning suits you, all you have to do is click the option.
If the positioning does not suit you, all you have to do is click inside the window:
the controls are moved back to their initial position.

Managing anchors

Let's see the visual aspect of our window:

1. On the "Modification" pane, in the "Preview" group, click "Preview". This runtime mode is used
to display the window interface. The different codes are not run.
2. Enlarge the window via the sizing handle found at the bottom of the window. The position
of controls is not modified and the window displays a large empty area. Two methods can be
used to solve this problem:
• Forbid the window from being resized
• Manage the anchors, which means manage the behavior of controls when resizing the
window. That's what we are going to do.

Part 4: Full application with data 143

 3. Close the preview: click the "Close" button or the cross found in the top right corner of the
window.

How to manage the anchors in a window?

To manage the anchors:
1. In the editor, reduce the window to its minimum size. All the outside borders
Notes

of the window must be "stuck" to a control.

2. Consider the controls one by one and ask yourself the following question:
"How does this control must react when the window is enlarged?". Then,
apply the corresponding anchor.

For this window, we are going to define the anchors together:

1. The "Validate" and "Cancel" buttons must always be stuck to the right.
• Select these two controls.
• Display the popup menu (right mouse click) and select "Anchor".
• In the window for defining anchors, select "Right" and validate.

144 Part 4: Full application with data

 • Small red arrows appear in the editor, indicating that the controls are anchored to the right.
2. The edit controls must increase in width:
• Select the 4 edit controls.
• Display the popup menu (right mouse click) and select "Anchor".
• In the window for defining anchors, select "Width" ( ).
• Validate.
3. We are going to check the operating mode of this window in preview:
• On the "Modification" pane, in the "Preview" group, click "Preview".
• Enlarge the window: the controls follow the enlargement in width.
• We must now define the operating mode during the enlargement in height.
4. The "Description" control can contain a product description that is more or less important.
This is the most important window control: it must occupy the maximum available space. Apply
an anchor in width and height to it ( ).
5. The "Price BT" is automatically bordered by a red line: the window editor signals an
anchoring problem. Indeed, if the "Description" control stretches to the bottom, the "Price BT"
control must move to the bottom accordingly.
6. Open the anchoring window for the "Price BT" control. The best anchor is automatically
proposed: "width and bottom" (a green checkmark is displayed). Select the proposed anchor
and validate.
7. We are going to check the operating mode of this window in preview:
• On the "Modification" pane, in the "Preview" group, click "Preview".
• Enlarge the window: the controls follow the enlargement in width and in height.

8. Close the window preview to go back to the editor.

Part 4: Full application with data 145

 Displaying the form from the list of products
Now, let's see how to display the form of the product selected in the list of products. The principle
is straightforward: the user will select the product in the Table control and will display the details
via a button.
We are going to modify the "WIN_Menu" window in order to create a modification button:
1. Position on the "Menu" window: click the "WIN_Menu" button in the button bar:

2. At this time, the Table control occupies the entire window. Enlarge the window to the right:
• Keep the [SHIFT] key down.
• Enlarge the window via its sizing handles.
Notes

Pressing the SHIFT key allows you to ignore the anchoring options of controls
when resizing the window.

3. We are now going to create the button for viewing the product on the right of the table.
To create the button for viewing the product:
1. On the "Creation" pane, in the "Usual controls" group, expand "Button" (click the arrow found
below ).
2. In the list of preset buttons, click "Modify". The shape of the button appears under the
mouse. Then, click on the right of the Table control to create the button.

3. Right-click the button and select "Code" from the popup menu.
4. In the code window that is displayed, type the following code in the "Click" process:
Open(WIN_Product_form)

146 Part 4: Full application with data

 The completion helps you type the code: as soon as the first opening bracket
"(" is typed, a drop-down list proposes the name of all the windows found in the
Notes project. All you have to do is select the window with the keyboard or with the
mouse.
If the window name is not displayed in the list, it means that this window was not
saved beforehand.

5. Let's study this code: Open is used to open the "WIN_Product_form" window. This function
was already presented in the first part of this tutorial.
6. Save the modifications by clicking among the quick access buttons.
7. Close the code window (click the cross in the top right corner of the code editor).

We are now going to modify the "WIN_Product_form" window to display the selected product in the
Table control.
Display the "WIN_Product_form" window in the editor: click the corresponding button in the
button bar.
To display the product data:
1. Display the processes associated with the window:
• Perform a right mouse click in the area found beside the window (called "Home area").
• Select "Code" from the popup menu that is displayed.
• The code editor appears.
2. Type the following code in the "End of initialization of WIN_Product_form" process:
// Assigns the content of items to the controls
FileToScreen()

FileToScreen is used to display in the controls the data found in the data file, for the current re-
cord. In our case, the current record will be the record selected in the Table control of the "WIN_
Menu" window.
3. Close the code window.
4. Save the window.
Display the "WIN_Menu" window in the editor: click the corresponding button in the button
bar.
Run the window test ( among the quick access buttons).
• In the list of products, click one of the products with the mouse.
• Click the "Modify the element" button.
• The detailed window of the product is displayed.
Close the windows by clicking the cross (x) in the top right corner of windows.

Part 4: Full application with data 147

 Managing the modification of a product
We are now going to modify the "WIN_Product_form" window in order to manage the modification
of a product.
We are going to:
• allow the user to modify the image of the product.
• add buttons to save or cancel the modifications performed in the form.

Modifying the image of the product

The user will be able to modify the image of the product in the Product form. To do so, we are going
to create a "Modify" button below the image of the product. This button will open a file picker used
to select the requested image
Display (if necessary) the "WIN_Product_form" window in the editor: click the corresponding
button in the button bar.
To create the modification button:
1. On the "Creation" pane, in the "Usual controls" group, expand "Button": the list of preset
buttons is displayed. Click "Modify".
2. The shape of the button appears under the mouse. Click in the window, below the image of
the product.
3. Resize the button if necessary (with the handles) in order for the button and the Image
control to have the same width.
Notes

When resizing the control, an automatic magnetism effect simplifies the

alignment of the button with the Image control.

4. Right-click the button. Select "Code" from the menu that is displayed.

148 Part 4: Full application with data

 5. In the code window that is displayed, type the following code in the "Click" process:
fImageSelect(

6. The code editor proposes a code wizard.

• Click "Wizard for fImageSelect".
• The code wizard starts.

WINDEV proposes several code wizards that will generate the corresponding
Notes

code lines via simple questions. Don't hesitate to use them, you will avoid syntax
errors.

7. Keep all the default options proposed by the wizard and validate. The corresponding code is
automatically inserted.
sFile is string

// Opens the image picker

sFile = fImageSelect("", "", "Select an image...")

8. Then, add the following code:

// If a file was selected
IF sFile <> "" THEN
// Assigns the image to the Image control
IMG_Visual = sFile
END

This code is used to assign the selected file to the Image control found in the window.
9. Close the code editor (click the cross in the top right corner of the code window).
This feature will be checked when the management of modifications performed in the form is
completed.

Validate the modifications made to the product

Two buttons have been created in the "WIN_Product_form" window:
• a "Validate" button to manage the validation of modifications
• a "Cancel" button to manage the return to the list of products.
We are now going to type the WLanguage code required for them to operate.
Display (if necessary) the "WIN_Product_form" window in the editor: click the corresponding
button in the button bar.

Part 4: Full application with data 149

 We are now going to type the code of the "Validate" button.
1. Right-click the button and select "Code" from the popup menu.
2. In the "Click" process, enter the following code:
ScreenToFile()
HModify(Product)
Close()
Let's study this code:
• ScreenToFile is used to initialize the items with the values of linked controls, for the current
record. This function is equivalent to the following code lines:
Product.Reference = EDT_Reference
Product.Caption = EDT_Caption
Product.Description = EDT_Description
...

Our window is using less than 10 controls and the benefit is already there; think of the
windows that use a lot more controls: a single code line performs all the assignments !
• HModify is used to update the data found in the data file for the current record.
3. Save the modifications by clicking among the quick access buttons.
4. Close the code window (click the cross in the top right corner of the code editor).
The modifications performed in the "Product form" window must be taken into account in the
Table control used to list the products. To do so, we are going to modify the code of the
"Modify" button in the "WIN_Menu" window.
1. Display the "WIN_Menu" window in the editor: click the corresponding button in the button
bar.
2. Select the "Modify" button and display the code editor ("Code" from the popup menu of the
button).
3. Modify the "Click" process as follows:
Open(WIN_Product_form)
TableDisplay(TABLE_Product, taCurrentSelection)

Let's study this code:

• TableDisplay is used to update the Table control.
• The taCurrentSelection constant is used to specify that the Table control must be updated
from the position of the selection bar.
4. Save the modifications by clicking among the quick access buttons.
5. Close the code window (click the cross in the top right corner of the code editor).

150 Part 4: Full application with data

Checking the modification of a product

To check the modification of a product:

1. Run the project test ( among the quick access buttons).

2. WINDEV asks you to select the first project window. In our case, this window corresponds to
"WIN_Menu". Select this window and validate.

The first project window corresponds to the first window that will be opened
when starting the application.
The first project window can be defined:
• during the project test.
Notes

• when creating the executable.

• in the project explorer: select the requested window, display the popup menu
and select "First project window".
When a first project window is defined, a small red 1 is displayed in front of the
window name in the project explorer.

3. In the list of products, select a product in the Table control (the first one for example) and
click the "Modify" button.
4. The details of the selected product are displayed in the form window.
5. Modify the price of 164.93 Dollars and type 200.00 Dollars, then click the "Validate" button.
6. When going back to the list of products, you will notice that the price was updated for this
product.
7. Display the project details again.
8. Click the "Modify" button below the image. The image picker is displayed. Select an image
and validate. The image is displayed in the form.
9. Click the "Cancel" button. The image modification was ignored in the data file.
10. Click the cross to close the application.

Part 4: Full application with data 151

 Creating a new product
The principle for creating a product is as follows:
• In the window used to list the products, we are going to add a "New" button that will be used to
open the "Product form" window.
• Then, we will modify the code of the "Product form" window to manage the addition into the
Product data file.

Adding a button

To add a "New" button into the "WIN_Menu" window:

1. Display the "WIN_Menu" window in the editor: click the corresponding button in the button
bar.
2. On the "Creation" pane, in the "Usual controls" group, expand "Button" and select "New".
3. The shape of the button appears under the mouse. Click in the window: the button is
created.
4. Position the button above the "Modify" button (modify the position of the "Modify" button if
necessary).

5. Modify the code of this button:

• Right-click the button and select "Code" from the popup menu.
• In the "Click" process, enter the following code:

HReset(Product)
Open(WIN_Product_form)
TableDisplay(TABLE_Product, taCurrentRecord)

Let's take a look at this code:

• HReset initializes the variables of the items found in the "Product" file with the default values
to manage a new record.
• Open is used to open the product form to enter the new record.
• TableDisplay is used to re-display the Table control. The taCurrentRecord constant is used in
this code: the Table control is re-displayed from the current record.
6. Save the modifications by clicking among the quick access buttons.
7. Close the code window (click the cross in the top right corner of the code editor).

152 Part 4: Full application with data

Addition into the data file

We are now going to modify the window of the product form to manage the addition of a new
record.
1. Display the "WIN_Product_form" window in the editor.
2. We are going to modify the code of the validation button:
• Right-click the "Validate" button and select "Code" from the popup menu.
• In the "Click" process, replace the existing code by the following code:
ScreenToFile()
IF Product..NewRecord THEN
HAdd(Product)
ELSE
HModify(Product)
END
Close()
Let's study this code:
• ..NewRecord is used to find out whether the current record must be created.
• If HReset was called beforehand, the property returns True (case of a click on "New product")
and the record must be created by HAdd.
• Otherwise, the current record already exists and it must be modified by HModify.
• HAdd adds the record into the data file. This function takes the values in memory and writes
the content of file items into the data file itself. The indexes are immediately and
automatically updated. In this case, it is the "Product" data file that is updated.

The test code of the new record can be replaced by HSave. This function is used
to check whether the record is already found in the data file, and it allows you to
Notes

add it or to modify it. The code becomes:

ScreenToFile()
HSave(Product)
Close()

3. Save the modifications by clicking among the quick access buttons.

4. Close the code window (click the cross in the top right corner of the code editor).

Part 4: Full application with data 153

 Checking the addition of a product

To check the addition of a product:

1. Run the project test ( among the quick access buttons).
2. In the list of products, click the "New" button.
3. Enter a new product with the following characteristics:
• Reference: REF-337
• Caption: WB Surf
• Description: Surf with WINDEV colors
• Price: 150

4. Validate. The new product is displayed in the list of products.

5. Click the "New" button again.
6. Enter a new product with the following characteristics:
• Reference: REF-337
• Caption: WB Surf
• Description: Surf with WEBDEV colors
• Price: 150
7. Validate. A specific window is displayed:

154 Part 4: Full application with data

 This window signals to the user that a duplicate was found: the reference (that is a unique
key) is identical for two products. This window is used to modify the value of the reference:
enter "REF-338" for example.
This window is one of the windows for automatic management of HFSQL errors.

Several errors may occur when adding or modifying a record: duplicate error,
integrity error, password error, ...
WINDEV proposes several modes for managing these errors:
• the automatic mode: a specific window is displayed to the user whenever an
error occurs when managing the database records. This window allows the
Notes

user to modify his data directly.

• the advanced programmed mode: a procedure or a window for error
management is called whenever an error occurs when managing the database
records.
The "Detecting Errors" example, supplied with WINDEV, allows you to check these
different modes for error management. This example can be opened by the
home window of WINDEV (CTRL <), via the option "Open an example".

Viewing the records

The new added records can be immediately viewed in the Table control of the "WIN_Menu" window.
However, in some cases (when running tests for example), you may want to see the content of the
data file directly.
WINDEV proposes a tool used to view the content of data files while the application is being
developed (when the viewing windows have not been created yet).
This tool is named WDMAP. We are going to use it to see the content of the Product file.

Part 4: Full application with data 155

 To start WDMAP:
1. On the "Tools" pane, in the "Database" group, click "WDMap".
2. Select the "Product" file. The content of the data file is displayed.

3. Sort the elements by reference (click the header of the "Reference" column) and to two
added records appear.

156 Part 4: Full application with data

 Lesson 4.3.  Simple search and
record browse

This lesson will teach you the following concepts...

• Managing the search for records

• Browsing records

Estimated time: 30 min

Part 4: Full application with data 157

 Overview
We have managed the addition and modification of records. It's fine. But it would be even better to
be able to find a record (to modify it for example). That's what we are going to do now.
We are going to modify the main window of the "WD Full Application" application to use the tab
panes.
The first tab will be used to display the list of products and to manage the addition and modification
of products (the operations have been performed in the previous lessons).
The second tab will propose to find a customer according to his name. The customer form will be
displayed in the tab.
Two search modes will be implemented:
• an exact-match search,
• a generic search.

Then, you will have the ability to browse the records found in the data file from the customer
displayed.

A corrected project is available. This project contains the different windows

Answer

created in this lesson. To open the corrected project, on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (With
windows)".

158 Part 4: Full application with data

Modifying the window: using a Tab control
In this example, the search will not be performed in a new window: the WIN_Menu window will be
used. At this time, this window displays the list of products.
We will be using tabs to display various data in this window. The tabs are used to group information
by theme. The user can directly access a theme by clicking the requested "pane".
This system is used in all the description windows of WINDEV.

Creating the Tab control

To display the data of the "WIN_Menu" window in a tab:

1. Display the "WIN_Menu" window if necessary:
• from the button bar.
• by double-clicking its name in the project explorer.
2. Select the window controls and move them to the home area of the window. This operation
may seem to be "weird" but it will make it easier to work on the Tab control then to associate
the controls to the requested tab.

Part 4: Full application with data 159

 3. Create a Tab control in a window:
• On the "Creation" pane, in the "Containers" group, expand "Tab and associated" and select
"Tab".
• Click in the window to create the Tab control.
• Position the Tab control in the top left corner of the window.
• A Tab control is created with two panes by default. The Tab control occupies the entire
available space in the window.
4. Select the controls found in the home area of the window and move them to pane 1.
5. A green border appears when hovering controls on the Tab control. This border indicates
that the controls placed on the current pane will be automatically associated with the pane.
6. Enlarge (if necessary) the window and the Tab control to display the Table control and the
buttons in the Tab control.

Handling controls in a Tab control:

• To check whether all the controls are associated with the current tab pane,
Notes

click another tab pane: all the controls associated with the tab disappear.
• To resize the Tab control while ignoring the anchors defined for the controls
found in the pane, press the [SHIFT] key during the resize operation.

160 Part 4: Full application with data

Modifying the Tab control

Modify the name of the Tab control:

1. Double-click the Tab control that was just created: the description window of the control is
displayed.
2. Modify the name of the control. The control is named "TAB_Viewing".
3. Validate the description window of the control.
Two panes are created by default. We are going to modify their caption directly:
1. Select the Tab control.
2. Click "Pane 1". The pane switches to edit: enter the "List of products" caption. Press the
[ENTER] key to validate.

3. Click "Pane 2". The pane is displayed. Click "Pane 2" again. Enter the caption: "Finding
customers". Press the [ENTER] key to validate.
We are going to associate an image with each tab pane. To do so:
1. Display the description window of the Tab control (double-click the control for example). The
"General" tab of the description window is used to configure the characteristics of each tab
pane. The list of panes is displayed on the left. For each selected pane, its characteristics can be
modified in the right section of the screen.
2. In the description window, select the "List of products" pane.

3. The characteristics of the pane are displayed.

4. We are going to associate an image with the tab via the image catalog of WINDEV.

Part 4: Full application with data 161

 Notes As soon as an image can be displayed in a control or in a window, WINDEV
proposes to use the image catalog via the "Catalog" button. This catalog contains
hundreds of images, cliparts, ...

5. Click the "Catalog" button. The window of the image catalog is displayed.
6. Select the "Flat Soft" theme in the "Theme" combo box, then type "Product" in the search
area. Click the magnifier to start the search.

7. Select the image and validate (green button).

8. The screen for configuring the generated image is displayed. This screen is used to modify
the characteristics of the image to generate: size, lightness, ... Keep the default options and
validate.
9. The image is generated in the project directory and the corresponding file is automatically
associated with the current element.
10. In the description window, click "Finding customers" in the list of static panes.
11. In the right section of the window, click the "Catalog" button. The window of the image
catalog is displayed.
12. In the search area, specify "Person" (the "Flat Soft" theme used for our last search is
selected by default). Click the magnifier to start the search.
13. Select, among the proposed images, the icon representing two persons ( ) and validate.
14. Keep the options found in the setting screen of the generated image and validate.
15. Validate the description window of the Tab control.
A new control was just created: we must now define its anchor in the window. When the
window is enlarged, the Tab control must also be enlarged in order to occupy the entire
available space. Therefore, the control must stretch to the right and to the bottom.
1. Select the Tab control.
2. Display the popup menu (right mouse click) and select "Anchor".
3. In the window for defining the anchor, select and validate.
4. Save the window by clicking among the quick access buttons.

162 Part 4: Full application with data

Implementing the search
The "WIN_Menu" window was entirely created. We must now concentrate on the content of the tab
for finding customers.
This tab will be divided into several areas:
• An area for entering the sought elements.
• An area for displaying the information found.
• An area containing the browse buttons.

Area for displaying the information found

First of all, we are going to create the different controls used to display the information about the
customer.
The method for creating the edit controls in the window is the same as the method for creating the
form window of the product: a simple Drag and Drop from the "Analysis" pane.
To create the different controls used to display information about the customer:
1. Display the WIN_Menu window in the editor and click the "Finding customers" tab. The empty
tab pane appears.
2. Display the "Analysis" pane if necessary: on the "Home" pane, in the "Environment" group,
expand "Panes" and select "Analysis". The different data files described in the "WD Full
Application" analysis appear in the pane.
3. Click on the left of "Customer" file: the items found in the data file are listed.
4. With the mouse, select all the items displayed in the pane. You have the ability to use the
multi-selection by keeping the [CTRL] key down.
5. Drag and Drop these items to the "Finding customers" tab.

Part 4: Full application with data 163

 6. The controls are automatically created in the tab. These controls are automatically linked to
the corresponding item in the data file.
7. Save the window.
We are going to align the controls and give them the same size:
1. Select the "City" control then all the edit controls found in the window (keep the [CTRL] key
down while clicking the different controls for example). The first selected control will be used as
reference for the size of the other controls.
2. On the "Alignment" pane, in the "Inside and outside" group, click "Justify (Ins. and Out.)".

Run the window test ( among the quick access buttons). Click the "Finding customers"
tab pane. The window is displayed with empty controls.

Exact-match search
To perform an exact-match search, we are going to select the name of the customer in a Combo
Box control. The "Find" button will be used to display the form of the corresponding person. A
single person corresponds to the selected name.
The Combo Box control will be positioned above the created controls. If your controls are too
close to the tab, they must be moved to the bottom. To do so:
1. Select all the controls found in the tab:
• Use the [CTRL] + A combination: all the controls found in the window and in the current pane
are selected.
• Press the [CTRL] key.
• Click the tab: only the controls found in the tab pane are selected.
2. With the mouse, move one of the selected controls to the bottom.

164 Part 4: Full application with data

 3. All the controls are moved to the bottom.
To create the search control:
1. Create a Combo Box control: on the "Creation" pane, in the "Usual controls" group, click
"Combo box".
2. Click in the "Finding customers" pane, in the section found between the tab pane and the
"Customer identifier" control.
3. The wizard for creating combo boxes is displayed. We are going to create a combo box
based on the "Customer" data file.

Part 4: Full application with data 165

 4. Select "Display the data found in a file or in an existing query". Go to the next wizard step.
5. Select the "Customer" data file. Go to the next step.
6. We are going to display the last and first names of the person.

• Deselect the "CustomerID" item.

• Select the "FullName" item.
Go to the next step.
7. The "FullName" item will also be used to sort the list of customers displayed in the Combo
Box control. Select the "FullName" item. Go to the next step.

166 Part 4: Full application with data

 8. The value returned by the Combo Box control will be the "CustomerID" identifier. This is the
value that will be sought in the Customer file. Select the "CustomerID" item and go to the next
step.

9. The Combo Box control will be linked to no item. Keep "No" and go to the next step.
10. Validate the next screen with the yellow arrow.
11. Give a name ("COMBO_Customer" for example) and a caption ("Sought customer" for
example) to the control.
12. Validate. Position the Combo Box control in the window (top left corner for example).
13. Select the Combo Box control and resize it (with the handles) in order for the full customer
name to be displayed.

Part 4: Full application with data 167

 To create the search button:
1. Create a button: on the "Creation" pane, in the "Usual controls" group, click .
2. Position the button beside the combo box that was just created.
3. This control is named "BTN_ExactMatchSearch" and its caption is "Exact-match search".
4. Adapt (if necessary) the button size in order for the caption to be properly displayed in the
button.
5. Type the following code:
// Finds the customer from his identifier
HReadSeekFirst(Customer, CustomerID, COMBO_Customer)
IF HFound(Customer) THEN
// Displays the customer data
FileToScreen()
END

6. Let's study this code:

• HReadSeekFirst is used to perform an exact-match search. In this example, the search is
performed on the Customer file and on the CustomerID item. The sought value corresponds
to the last parameter of the function. In this case, the sought value corresponds to the value
selected in the combo box. This value is obtained by using the name of the combo box
(COMBO_Customer).
• HFound is used to check the search result. If HFound returns True, a value was found ; if
HFound returns False, no value was found. Any record found is read: it becomes the current
record in the data file.
• In this code, FileToScreen is used to display the record found.

FileToScreen performs the reverse operation of ScreenToFile: the data found in

Note

the file items is displayed in the corresponding controls.

7. Close the code editor.

8. Save the window.
Let's run a window test:
1. Run the window test ( among the quick access buttons).
2. Click the "Finding customers" tab if necessary.
3. Select a value in the combo box and click the search button.

168 Part 4: Full application with data

 4. The result is immediate.
5. Close the test window to go back to the editor.

Generic search
We are now going to perform a generic search. Instead of searching for the exact value that was
entered, we are going to search for all the elements that start with the value entered.
To perform this search, we are going to create an edit control that will be used to enter the sought
name and a button that will be used to perform this search.
To create the search control:
1. Display (if necessary) the "Finding customers" tab of the "WIN_Menu" window in the editor.
2. Create an edit control: on the "Creation" pane, in the "Usual controls" group, click .
3. In the window, click below the Combo Box control ("Sought customer"). The edit control is
created.
4. This control is named "EDT_Sought_name" and its caption is "Sought name".

Part 4: Full application with data 169

 To create the search button:
1. Create a button: on the "Creation" pane, in the "Usual controls" group, click .
2. Position the button beside the edit control that was just created.

3. This control is named "BTN_GenericSearch" and its caption is "Generic search".

4. Adapt (if necessary) the button size in order for the caption to be properly displayed in the
button.
5. Type the following code:
// Finds a customer from his name
HReadSeek(Customer, FullName, EDT_Sought_Name)
IF HFound(Customer) THEN
// Displays the customer data
FileToScreen()
ELSE
Error("No customer matches")
END

HReadSeek is used to perform a generic search. In this example, the search is performed on
the "Customer" file and on the "FullName" item. The sought value corresponds to the value
entered in the "EDT_Sought_Name" control. This value is obtained by using the control name.

An exact-match search can be performed by HReadSeek: to do so, use the

Note

hIdentical constant.

6. Close the code window.

7. Save the window.
Let's run a window test:
1. Run the window test ( among the quick access buttons).
2. Click the "Finding customers" tab if necessary.
3. Enter a value in the edit control ("BEEF" for example) and click the search button.

170 Part 4: Full application with data

 4. The result is immediate. However, if several records correspond to the search, only the first
one is displayed.
5. Stop the test and go back to the editor.

Browsing forms
We are now going to add four buttons used to browse the different records of "Customer" file.
These buttons are "recorder buttons".

They include an icon and they are used to display:

• the first record,
• the previous record,
• the next record,
• the last record.
To create the button used to display the first record of the data file:
1. Display (if necessary) the "Finding customers" tab in the editor.
2. On the "Creation" pane, in the "Usual controls" group, click .
3. The shape of the button appears under the mouse. Click in the tab, below the "Generic
search" control. The button is automatically created.
A skin template will be used to standardize the interface of project windows. This skin
template defines the style for all the controls found in the windows. A specific style is defined
for each recorder button. To apply this style:
1. Select the button if necessary.
2. Display the popup menu (right mouse click) and select "Choose a style".

Part 4: Full application with data 171

 3. All the defined for the buttons are displayed in the window. Select the "BTN_First" style.
4. Validate.
Modify the name of the Button control:
1. Display the description window of the control:
• Select the Button control.
• Display the popup menu (right mouse click) and select "Description".
2. This control is named "BTN_First".
3. Validate the description window.
We are now going to enter the WLanguage code associated with this control:
1. Right-click the control. Select "Code" from the menu that is displayed.
2. In the code window that is displayed, type the following code in the "Click" process:
// Reads the first customer
HReadFirst(Customer)
IF HOut(Customer) = True THEN
// No customer
Info("No form to view.")
ELSE
// Displays the customer data
FileToScreen()
END

HReadFirst is used to read the first record of the data file, according to the key used for the
last search (FullName in our case).

172 Part 4: Full application with data

Create 3 new buttons according to the same method.
• These buttons are named: "BTN_Previous", "BTN_Next" and "BTN_Last".
• These buttons are respectively associated with the styles: "BTN_Previous", "BTN_Next" and
"BTN_Last".
• The code of the "BTN_Previous" button is as follows:
// Reads the previous customer
HReadPrevious(Customer)
// If the beginning of file is exceeded
IF HOut(Customer) = True THEN
Info("Beginning of file reached.")
ELSE
// Displays the customer data
FileToScreen()
END
• The code of the "BTN_Next" button is as follows:
// Reads the next customer
HReadNext(Customer)
// If the beginning of file is exceeded
IF HOut(Customer) = True THEN
Info("End of file reached.")
ELSE
// Displays the customer data
FileToScreen()
END

• The code of the "BTN_Last" button is as follows:

// Reads the last customer

HReadLast(Customer)
IF HOut(Customer) = True THEN
// No customer
Info("No form to view.")
ELSE
// Displays the customer data
FileToScreen()
END

In these different codes:

• HReadLast is used to read the last record of the data file, according to the key used for the last
search.
• HReadNext reads the record whose key value is immediately greater than the one of the current
record.
• HReadPrevious reads the record whose key value is immediately less than the one of the current
record.
In any case:
• HOut is used to find out whether the data file is empty.
• FileToScreen is used to display the record on the screen.
Save the window by clicking among the quick access buttons.

Part 4: Full application with data 173

 Window test

Let's run a window test:

1. Run the window test ( among the quick access buttons).
2. Click the "Finding customers" tab if necessary.
3. Find a customer (perform a generic search on "BEEF" for example).
4. Browse the data file by clicking each one of the browse buttons.
5. Stop the test to go back to the editor.

174 Part 4: Full application with data

 Lesson 4.4.  Multicriteria search

This lesson will teach you the following concepts...

• Creating a query with parameters.

• Creating the interface used to select the search criteria.
• Passing parameters to a query.
• Displaying the query result in a Table control.

Estimated time: 40 min

Part 4: Full application with data 175

 Overview
In the previous lesson, we have explained how to perform a search on a single criterion (the
customer name). In this lesson, we will give the user the ability to perform a multicriteria search.
In our example, this search will be performed on the "Orders" file. The user will be able to select:
• the status of the order,
• the payment mode,
• the order dates taken into account.
The interface of the "WIN_Menu" window is as follows:

This interface includes:

• controls used to select the search criteria.
• buttons used to start the search or to print the result.
• a Table control used to display the search result. This Table control is based on a query. This
query will be used to select the records to display. The Table control will list the search result.

The first step consists in creating the query used to select the records.

What is a select query?

A select query is a query that will "choose" the records corresponding to the
Notes

specified criteria.
This type of query is called a select query because the SELECT command is used
in SQL language.

176 Part 4: Full application with data

 A corrected project is available. This project contains the different windows

Answer
created in this lesson. To open the corrected project, on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (With
windows)".

Creating the query used to find the orders

Creating the query

The query editor will be used to create the query.

1. Click among the quick access buttons. The window for creating a new element is
displayed: click "Query". The wizard for query creation starts.
2. Select the "Select" option.
Indeed, the query that will be created will allow us to select records. Go to the next step.
3. The description window of the query is displayed. To build the query, we are going to select
the elements that will be displayed in the result.
4. Double-click the items found in the analysis on the left of the description window. The
items taken into account are displayed in the middle of the screen.
Note: To display the items of the different data files, all you have to do is click the arrow
found in front of the file name.
We want to display:
• the information regarding the order. Expand the "Orders" file (click the arrow ) and double-
click the following items: OrdersID, Date, Status and TotalBT.
• the information regarding the customer who placed the order. Expand the "Customer" file
(click the arrow ) and double-click the "FullName" item.
• the information regarding the payment mode of the order. Expand the "PaymentMode" file
(click the arrow ) and double-click the "Caption" item.

Part 4: Full application with data 177

 The description window of the query is as follows:

5. The data will be sorted by date.

• In the list of query elements, select the "Orders.Date" item, then click the "Sort" button and
select "Sort on the selected item".

• In the window that is displayed, specify an ascending sort on the item and validate.

178 Part 4: Full application with data

 6. A blue arrow with the number 01 appears on the right of the "Orders.Date" item. This arrow
indicates that an ascending order is performed on this item. The number "01" indicates that
this sort will be performed first.

7. Give a name to the query: enter "QRY_FindOrders" instead of "QRY_NoName1" in the "Query
name" area:

8. Validate the description window of the query (green button at the bottom of the screen).
9. The backup window is displayed. Validate the proposed information.
10. The graphic representation of the query is displayed:

Part 4: Full application with data 179

 Query test
Like all the elements found in a WINDEV project, you have the ability to run the test of the query
that was just created:
1. Click .
2. The result is displayed in a window:

The result lists ALL the orders.

In our case, we want to display the orders corresponding to the search criteria only. To do so,
we must use a query with parameters.

A popup menu is displayed when a right click is performed on the query result.
You have the ability to export the result to:
• an XLS file (Excel).
Notes

• a Word or OpenOffice file.

• an XML file (eXtensible Markup Language).
• a text file.
• a HFSQL file.

3. Close the window.

180 Part 4: Full application with data

Using parameters in the query
In our example, the user will be able to select a value for the following search criteria:
• Status of the order.
• Payment mode of the order.
• Date of the order.
We must modify the query in order for these search criteria to correspond to the query parameters.
To define the query parameters, display the description window of the query: double-click the
background of the graphic representation of the query (or select "Query description" from the
popup menu).
To manage the "status of the order" parameter:
1. Select the Orders.Status item (in the middle of the screen).
2. Expand the "Selection condition" button and select "New condition".
3. In the window that is displayed, we are going to specify that the selection condition
corresponds to a parameter:

• Select "Is equal to".

• Select "the parameter".
• Specify the parameter name: "pStatus".

We advise you prefix the parameters of queries with the letter "p". Therefore, you
will be able to easily find them in the code editor.
Notes

To find a query parameter, all you have to do is type 'p' and the completion
feature of the code editor will propose all the parameters.

Part 4: Full application with data 181

 4. Validate the description window of the condition. The number "1" appears on the right of the
"Orders.Status" item, indicating that a selection condition was defined.

We are now going to define a condition on the payment mode. This item is not found in the
query result but a condition will be applied to it. To do so, the item will be included in the
query result and it will be made invisible so that it is not visible in the result.
1. On the left section of the description window of the query, in the "Orders" file, double-click the
"PaymentModeID" item. The "PaymentModeID" item appears in the list of query elements.
2. To avoid displaying this item in the result:
• Click found on the right of the item.
• In the menu that is displayed, select "Don't display".
3. To define a selection condition on the "Orders.PaymentModeID" item:
• Select the "Orders.PaymentModeID" item (in the middle of the screen).
• Expand the "Selection condition" button and select "New condition".
• In the window that is displayed, specify that the selection condition corresponds to a
parameter:
• Select "Is equal to".
• Select "the parameter".
• Specify the parameter name: "pPaymentModeID".
4. Validate the definition of the selection condition.

182 Part 4: Full application with data

The last selection condition to define affects the order date. This date must be included
between two dates entered by the user.
1. In the list of query elements, select the "Orders.Date" item.
2. Click the "Between two dates ..." button. This button is used to directly define a selection
condition.
3. In the window that is displayed:
• The selection condition is "Is included between".
• Click "the parameter".
• Specify the parameter name: "pStartOfPeriod".
• Click the second "to parameter".
• Specify the parameter name: "pEndOfPeriod".
4. Validate the definition of the selection condition.
5. Validate the description window of the query. The query graph is modified to take into
account the selection conditions that have been defined.

6. Save the query by clicking among the quick access buttons.

Part 4: Full application with data 183

 Test of query with parameters

To run the test of the query with parameters:

1. Click .
2. A window is displayed, allowing you to enter the different query parameters.
3. Type the following data:
• Uncheck the pStatus parameter.
• Select the pStartOfPeriod parameter. In the lower section of the screen, type "01/01/2016".
• Select the pEndOfPeriod parameter. In the lower section of the screen, type "31/03/2016".
• Select the pPaymentModeID parameter. In the lower section of the screen, type "1".

4. Validate the window. The query result corresponding to the specified parameters is
displayed.
5. Close the window.
We are now going to create the interface used to specify the parameters of this query, to run it and
to display the result.

Creating the interface used to perform a multicriteria search

Modifying the Tab control

We are going to add a tab pane into the "WIN_Menu" window to display the result of the multi-
criteria search.
To add a tab pane:
1. Display (if necessary) the "WIN_Menu" window in the editor.
2. Select the Tab control.
3. Display the description window of the control ("Description" from the popup menu).
4. In the "General" tab of the description window, click the "New" button. A third tab pane
appears.

184 Part 4: Full application with data

 5. Click "Pane 3".
6. In the "Description of static pane" section, type the caption of the pane: "Finding orders".

7. We are going to associate an image to the tab via the image catalog of WINDEV. Click the
"Catalog" button. The window of the image catalog is displayed.
8. In the search area, specify "Search" and select the "Flat Soft" theme if necessary. Click the
magnifier to start the search.
9. Select, among the proposed images, the icon representing the binoculars and validate.
10. Keep the options found in the setting screen of the generated image and validate.
11. Validate the description window of the Tab control.

Part 4: Full application with data 185

 Creating the controls used to configure the criteria and to display the result
We now want to display the result of our multicriteria search.
We are going to create a Table control based on the query then the different controls allowing the
user to select the search criteria.
Creating the Table control

To create the Table control used to display the search result:
1. In the "WIN_Menu" window, click the "Finding orders" pane. The empty tab pane appears.
2. Create a Table control: on the "Creation" pane, in the "Data" group, expand "Table and list
box" and select "Table (Vertical)".
3. Click in the tab pane: the wizard for creating the Table control starts.
4. The Table control will be based on the "QRY_FindOrders" query (that was created
beforehand). Select "Display the data found in a file or in an existing query". Go to the next
wizard step.
5. Select the query that will be used as data source for the Table control:
• Expand the "Queries" group if necessary.
• Select the "QRY_FindOrders" query.

• Go to the next wizard step.

6. Select all the proposed items if necessary.

186 Part 4: Full application with data

 7. Go to the next wizard step.
8. Keep the default options in the different wizard steps and validate the creation of the Table
control.
9. The Table control is automatically created in the "Finding orders" tab.
10. Modify (if necessary) the position of the Table control so that it is entirely displayed in the
tab pane.

For better legibility, we are going to rename the captions of columns in the Table control.
1. Display the description of the Table control (double-click the control).

The description window of a Table control includes two sections:

• the upper section, presenting the name of the control, the name of columns as
well as their type.
Notes

• the lower section, containing the different description tabs.

If the name of the Table control is selected, the lower section presents the
characteristics of the Table control.
If a column is selected, the lower section presents the characteristics of the
columns.

2. Click the "COL_OrdersID" column. The column title is displayed in the lower section of the
screen. Replace the "Identifier of the order" caption by "ID".

Part 4: Full application with data 187

 3. Click the "COL_FullName" column. Replace the "Full name" caption by "Customer".

4. Click the "COL_Caption" column. Replace the "Caption" caption by "Payment mode".

5. Validate the description window of the Table control. The control is automatically updated
with the modifications performed.
6. Enlarge the ID, Date and Status columns in the Table control with the sizing handles of
columns.
7. Reduce the "Payment mode" column in order for all the columns to be displayed in the Table
control.
8. Save the window by clicking among the quick access buttons. We are going to check
the sizes of columns by running the window.

Live Data and controls based on queries

Notes

The Live data is not displayed in the controls that use a query as data source for
the following reason: the displayed data depends on the query result and it can
be known at run time only.

188 Part 4: Full application with data

We are going to run a first test of this window:
1. Click among the quick access buttons.
2. Click the "Finding orders" tab. Only 22 orders are displayed, like during the last query test
run in the editor, when parameters were specified in the test window of the query.

3. Close the test window to go back to the editor.

Let's study the processes associated with the Table control:
1. Select the Table control.
2. Display the popup menu (right mouse click) and select "Code".
3. The "Initializing TABLE_QRY_FindOrders" process contains the following code:
// Parameters of 'QRY_FindOrders' query
//MySource.pStatus = <Value of pStatus parameter>
MySource.pPaymentModeID = "1"
MySource.pStartOfPeriod = "20160101"
MySource.pEndOfPeriod = "20160331"

The test parameters have been retrieved as default parameters for the execution. We are now
going to modify the window in order for the parameters to be entered by the user, via controls.
4. Close the code editor (click the cross at the top right of the editor).

Part 4: Full application with data 189

 We are now going to create in our window the different controls allowing the user to select the
query parameters. These controls will be positioned above the Table control.
Move (if necessary) the Table control in the window and reduce its height in order to get
available space for creating the different controls.

First parameter: Status of the order

Three states can be assigned to an order:

• waiting for payment,
• paid
• canceled.
In our analysis, the status of the order is saved in the "Status" item found in the "Orders" data file.
This item is a radio button.
To allow the user to select one of these three states, we are going to use the Radio Button control
associated with the "Status" item of the "Orders" data file.

The radio buttons are also called "option box". They are used to select a single
option among the proposed ones.
How to differentiate between a radio button and a check box?
Notes

An easy way to remember: think of the old radios: a single frequency could be
selected via the button!
The radio button is used to select a single option.

To create the Radio Button control:

1. Display the "Analysis" pane if necessary: on the "Home" pane, in the "Environment" group,
expand "Panes" and select "Analysis". The different data files described in the "WD Full
Application" analysis appear in the pane.
2. Click on the left of the "Orders" file: the items found in the data file are listed.
3. Select the "Status" item found in the Orders file and Drag and Drop this item to the "WIN_
Menu" window.
4. The Radio Button control is automatically created. Position this control above the Table
control.

190 Part 4: Full application with data

We are now going to pass the value selected in the Radio Button control in parameter to the
query:
1. Display the processes associated with the Table control:
• Select the Table control.
• Display the popup menu (right mouse click) and select "Code".
2. In the initialization process of the Table control, replace the line:
//MySource.pStatus = <Value of pStatus parameter>

by the following code:

MySource.pStatus = RADIO_Status

In this code, RADIO_Status is the name of the Radio Button control that was just created. The
value of this control is associated with the pStatus parameter expected by the query.
3. Close the code editor.
Before running the test, we are going to create a button used to re-display the content of the
Table control according to the value selected in the Radio Button control:
1. Create a Button control:
• on the "Creation" pane, in the "Usual controls" group, click .
• then, click at the top right of the tab pane.
2. Select the control and press the [ENTER] key on the keyboard. The caption of the button
becomes editable. Type "Find" and press the [ENTER] key on the keyboard.
3. Modify the style of the control:
• Display the popup menu of the control (right mouse click) and select "Choose a style".
• In the window that is displayed, press [CTRL F]. In the search control, type "BTN_Search".
• The style is automatically selected. Validate.

Part 4: Full application with data 191

 4. Resize the control if necessary.
5. Display the code associated with this control: press the [F2] key.
6. In the "Click..." process, type the following code:
// Refreshes the display of the Table control
TableDisplay(TABLE_QRY_FindOrders, taInit)

In this code, the taInit constant is used to re-run the initialization process of the Table control
(the process in which the parameters are passed to the query).
7. Close the code editor.
We are now going to check how the first parameter is passed:
1. Save the window by clicking among the quick access buttons.
2. Click among the quick access buttons.
3. Select the "Finding orders" tab if necessary.
4. Change the status of orders via the radio button and click the "Find" button. The content of
the Table control is modified.

5. Close the test window.

192 Part 4: Full application with data

 Second parameter: Payment mode

Several payment modes can be used for an order: cash, check, ... The available payment modes
are stored in the "PaymentMode" data file.
We will be using a Combo Box control based on this data file to allow the user to select the
requested payment mode.

The "Combo Box" control is used to display a list of elements and to select an
element from this list.
Unlike a list box, a combo box is not expanded: it is expanded upon request or
when the cursor is positioned on the list.
Notes

The elements displayed in a combo box can be defined when creating the control
in the editor. These elements:
• are defined by programming.
• come from a data file or from a query.

To create a Combo Box control:

1. On the "Creation" pane, in the "Usual controls" group, click "Combo box".
2. Click the location where the control must be created in the window (beside the radio button
that was just created for example).
3. The wizard for creating the Combo Box control starts.
4. Select "Display the data coming from a file or from a query" and go to the next step.
5. Select the "PaymentMode" data file and go to the next step.
6. The item that must be displayed in the Combo Box control is "Caption". Uncheck
"PaymentModeID" and check "Caption". Go to the next step.
7. Select the sort item: "Caption". Go to the next step.
8. Select the return value: "PaymentModeID". This return value is very important because it
will be passed in parameter to the query. Go to the next step.
9. Keep the default options in the different wizard steps and validate the creation of the
Combo Box control.
10. The Combo Box control is automatically created in the window.
We are going to modify some characteristics of the Combo Box control:
1. Select the Combo Box control and display the description window of the control ("Description"
from the popup menu).
2. In the "General" tab, modify the caption of the control: replace "PaymentMode combobox"
by "Payment mode".
3. In the "Content" tab, specify the initial value displayed by the Combo Box control ("Initial
value" at the bottom of the description window). In our case, type "1". This value corresponds
to a payment in cash.
4. Validate the description window of the control.

Part 4: Full application with data 193

 Change the style of the control: to occupy less space, we are going to select a style that
displays the caption above the control.
1. Select the Combo Box control.
2. In the popup menu (right mouse click), select "Choose a style".
3. In the window that is displayed, select the "COMBO_Internal" style and validate.
4. Reduce the size of the control.
We are now going to pass the value selected in the Combo Box control in parameter to the
query:
1. Display the processes associated with the Table control:
• Select the Table control.
• Display the popup menu (right mouse click) and select "Code".
2. In the initialization process of the Table control, replace the line:
MySource.pPaymentModeID = "1"

by the code:

MySource.pPaymentModeID = COMBO_PaymentMode

In this code, COMBO_PaymentMode is the name of the Combo Box control that was just
created. The value of this control is associated with the pPaymentModeID parameter
expected by the query.
3. Close the code editor.
4. Save the window by clicking among the quick access buttons.
We are now going to check how the first two parameters are passed:
1. Click among the quick access buttons.
2. Select the "Finding orders" tab if necessary.
3. Change the status of orders via the radio button and modify the payment mode via the
Combo Box control, then click the "Find" button. The content of the Table control is modified.

4. Close the test window.

194 Part 4: Full application with data

 Last parameter: Order date
The last query parameter corresponds to the date of the orders taken into account. The user must
be able to enter a date interval. To do so, we are going to use a control template.

A control template is a specific window containing different controls. All types

of controls can be included in this window. A control template is a file whose
extension is "WDT".
Notes

The main benefit of a control template is the re-usability. A control template

found in a project can be re-used in any project window.
Furthermore, the control templates can be overloaded: code can be added, the
controls can be moved in the window that is using the control template. The
controls can also be modified.

To manage the order date:

1. In the project explorer, expand the "Templates of Controls" folder.
2. Select the control template named "TPLC_ChoosePeriod" and perform a Drag and Drop
toward the "WIN_Menu" window (beside the "Payment mode" control).

3. Select the created control template and display its description ("Description" from the popup
menu).
4. In the description window, rename the control template. The new name is "CTPL_
ChoosePeriod".
5. Validate the description window.
6. Reposition and align the controls if necessary.

Part 4: Full application with data 195

 We are now going to pass the selected dates in parameter to the query:
1. Display the processes associated with the Table control:
• Select the Table control.
• Display the popup menu (right mouse click) and select "Code".
2. In the initialization process of the Table control, replace the lines:
MySource.pStartOfPeriod = "20160101"
MySource.pEndOfPeriod = "20160331"

by

MySource.pStartOfPeriod = EDT_StartDate
MySource.pEndOfPeriod = EDT_EndDate

In this code, EDT_StartDate and EDT_EndDate are the names of the two edit controls found
in the control template. Their values are associated with the pStartOfPeriod and
pEndOfPeriod parameters expected by the query.
3. Close the code editor.
4. Save the window by clicking among the quick access buttons.
We are now going to check how the parameters are passed:
1. Click among the quick access buttons.
2. Select the "Finding orders" tab if necessary.
3. Define the different parameters of the search:
• Status of orders,
• Payment mode,
• Range of dates taken into account.
4. Click the "Find" button. The content of the Table control is modified.

5. Close the test window.

196 Part 4: Full application with data

 Lesson 4.5.  Printing the content of a
Table control

This lesson will teach you the following concepts...

• Printing the content of a Table control

• Printing an order form

Estimated time: 20 min

Part 4: Full application with data 197

 Overview
WINDEV allows you to print your data:
• by programming.
• via the reports. A report is the name given to the graphic representation of a print. A report is
created via the report editor.
WINDEV proposes several types of reports:

• Blank
• Form
• Label
• Table
• Crosstab
• TreeView table
• Multicolumn report
• Mailing
• Form
• Composite
• Organizer or scheduler
• Gantt chart
We are now going to explain how to create the different types of reports in the "WD Full Application"
application.

198 Part 4: Full application with data

 If you did not create the windows in the previous lessons, you can follow this
lesson by opening a corrected project: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "Full application (With windows)".
Answer

A corrected project of the application is also available: on the "Home" pane, in the
"Online help" group, expand "Tutorial" and select "Full application (Answer)". In
this case, to follow the rest of the lesson, select the "Windows 32-bit executable"
configuration in the project explorer.

Printing the content of a Table control

In the previous lesson, we have created a Table control used to display the result of a multi-criteria
search. Let's take a look at the different methods used to print the content of this Table control.

Direct print via the AAF (Automatic Application Feature)

In the previous lessons, you have noticed that several automatic features (called AAF) were
proposed by WINDEV. An AAF allows you to print the content of a Table control.

The entire list of AAFs (Automatic Application Features) is available in the

Note

WINDEV AAF 22.PDF file. This file is automatically included in your application if
you choose the "Help for AAF" option when creating the automatic menu.

Let's run a quick test:

1. Display (if necessary) the "WIN_Menu" window in the window editor.
2. Click among the quick access buttons.
3. Select the "Finding orders" tab if necessary.
4. Define the different parameters of the search:
• Status of orders,
• Payment mode,
• Range of dates taken into account.
5. Click the "Find" button.
6. When the data is displayed in the Table control, display the popup menu of the control (
in the top right corner or right mouse click on the control).

Part 4: Full application with data 199

 7. Click "Print".
8. Choose (if necessary) to print the content of the Table control in "Landscape" mode. The
report corresponding to the control is displayed in a preview window.

200 Part 4: Full application with data

 In test mode, the content of the Table control is printed directly.
Note At run time, the end user will be able to print directly or to start "Reports and
Queries" in order to create the corresponding report. See “Distribute “Reports
and Queries” with your applications”, page 307 for more details.

9. Close the preview window and stop the application test.

You want to customize the report proposed by default? All you have to do is create an automatic
report on the Table control. This report (if it exists) will be automatically used by the option for
printing the Table control.

Creating an automatic report on a Table control

To create a report used to print the data found in a Table control, all you have to do is create a
"Report on Table control": the report corresponding to the table is automatically created.

To create a "Report on Table control":

1. If necessary, in the window editor, display the "Finding orders" tab (click it).
2. On the "Creation" pane, in the "Data" group, expand "Table and list box" and select "Report
on Table control".
3. Our window containing 2 Table controls on different tab panes, WINDEV asks you to select
the requested Table control. In our case, select "TABLE_QRY_FindOrders" and validate.
4. The shape of a button appears under the mouse cursor. This button is automatically created
and it contains the code used to print the content of the Table control. Click the position where
the button will be created in the window (below the "Find" button for example in the "Finding
orders" tab).
5. The report is automatically created.
6. A window is displayed, allowing you to add the report to the project. Validate.
7. The report editor appears with the report that was automatically created.
8. Validate the backup window of the report.

Part 4: Full application with data 201

 9. This report includes the titles of the columns found in the Table control. We are going to
perform a modification in this report: we want to modify the title:
• Select the control corresponding to the report title ("QRY_FindOrders Table" is displayed in
the control) and double-click this control.
• In the description window, modify the caption and enter "Sought orders".
• Validate.
10. Go back to the "WIN_Menu" window (click the "WIN_Menu" button found in the bar of
opened elements for example).
11. Modify (if necessary) the size and position of the "Print" button (in order for its size to be
identical to the one of the "Find" button).
12. Save the window by clicking among the quick access buttons.

13. Run the window test: click among the quick access buttons.
• Select the "Finding orders" tab if necessary.
• Define the different parameters of the search:
• Status of orders,
• Payment mode,
• Range of dates taken into account.
• Click the "Find" button.
14. When the data is displayed in the Table control, click the print button or select the "Print"
option found in the popup menu of the Table control: the report that was just created is used
in both cases.

202 Part 4: Full application with data

 Lesson 4.6.  Printing an order

This lesson will teach you the following concepts...

• Creating a report based on a query

• Printing a report based on a query with parameters

Estimated time: 30 min

Part 4: Full application with data 203

 Overview
We want to give the user the ability to print the details of the sought order. The report can be
directly printed via the popup menu of the Table control.

If you did not create the windows in the previous lessons, you can follow this
lesson by opening a corrected project: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "Full application (With windows)".
Answer

A corrected project of the application is also available: on the "Home" pane, in the
"Online help" group, expand "Tutorial" and select "Full application (Answer)". In
this case, to follow the rest of the lesson, select the "Windows 32-bit executable"
configuration in the project explorer.

Creating the "Order form" report

First of all, we are going to list the information that will be displayed in the report:
• The characteristics of the order: date and order number.
• The personal details of the customer: name, address, zip code, city and country.
• The characteristics of the order lines:
• Quantity ordered,
• Product reference,
• Product caption,
• Total BT,
• Total IOT.
To easily create this report, the data to print will be grouped in a query. This query can be used by
the report or by any other element of the WINDEV project (Table control, Looper control, ...).

WINDEV proposes to create reports from several data sources: data files,
queries, controls, text files, ...
In most cases, we advise you to group the data to print via a query and to create
Note

a report based on this query. To add an information into the report, all you have
to do is add the corresponding item into the query.
The reports based on data files must be simple reports, which means reports
used to display data coming from a single data file.

204 Part 4: Full application with data

Creating the query

The query editor will be used to create the base query of the report.
1. Click among the quick access buttons. The window for creating a new element is
displayed: click "Query". The wizard for query creation starts.
2. Select the "Select" option.
Indeed, this query will be used to select the records that will be printed in the report. Go to
the next step.
3. The description window of the query is displayed. To build the query, we are going to select
the elements that will be displayed in the result.
4. Double-click the items found in the analysis on the left of the description
window. The items taken into account are displayed in the middle of the screen.
We want to print in the report:
• the details regarding the customer. In the "Customer" file, double-click the FullName,
Address, ZipCode, City and Country items.
• the information regarding the order. In the "Orders" file, double-click the OrdersID and Date
items.
• the details regarding the product. In the "Product" file, double-click the Reference, Caption
and PriceBT items.
• the details regarding the order line. In the "OrderLine" file, double-click the Quantity and
TotalBT items.
• the details about the grand total of the order. In the "Orders" file, double-click the TotalBT
and TotalIOT items.

The order in which the items are inserted into the query is important. Indeed,
this order corresponds to the order used to display the data in the report. The
Note

creation of the corresponding report will be simplified if this order is properly

defined.

Part 4: Full application with data 205

 The description window of the query is as follows:

At this time, this query is used to select all the orders and the corresponding order lines.
We want to select the data corresponding to a single order whose identifier is known. Therefore,
we are going to define the order number in parameter.
To manage the "Order identifier" parameter:
1. Select the Orders.OrdersID item (in the middle of the screen).
2. Expand the "Selection condition" button and select "New condition".
3. In the window that is displayed, we are going to specify that the selection condition
corresponds to a parameter:

206 Part 4: Full application with data

 Perform the following operations:
• Select "Is equal to".
• Check "the parameter".
• Specify the parameter name: "pOrderID".
4. Validate the description window of the condition. The number "1" is displayed on the right of
the Orders.OrdersID item, indicating that a selection condition was defined.
5. Give a name to the query: type "QRY_OrderForm" instead of "QRY_NoName1" in the "Query
name" area:

6. Validate the description window of the query (green button at the bottom of the screen).
7. The backup window is displayed. Validate the proposed information.
8. The graphic representation of the query is displayed:

Part 4: Full application with data 207

 Creating the report based on a query

To create a report:

1. Click among the quick access buttons.
2. The window for creating a new element is displayed: click "Report" then "Report". The wizard
for report creation starts.
3. The wizard for report creation proposes several types of reports:

4. Select "Table". Go to the next step.

5. Select the data source of the report. The report will be based on the query that was just
created. Select "From a data file or from an existing query". Go to the next step.

6. In the list of data files and queries, select the "QRY_OrderForm" query. Go to the next step.

208 Part 4: Full application with data

 7. The wizard asks you to specify whether a break is required. No break will be used in this
report. This concept will be presented later in this tutorial. Answer "No". Go to the next step.
8. You are going to specify the order in which the items will be printed and how they will be
distributed in the different blocks. In the wizard, the items are listed according to the order
defined in the query:
• The items regarding the customer will be displayed in the "Page header" block. Indeed, this
information must not be repeated on each line of the order.
For the FullName, Address, ZipCode, City and Country items, click the line corresponding to
the item. In the "Block" column, expand the combo box and select "Page header".

• The items regarding the order will also be displayed in the "Page header" block. Indeed, this
information must not be repeated on each line of the order. For the OrdersID and Date
items, click the line corresponding to the item. In the "Block" column, expand the combo box
and select "Page header".
• Furthermore, we are going to modify the caption of the "OrdersID" item.
• Select the line containing the OrdersID item.
• Click the Caption column and enter "Order #".

• The items regarding the order lines will be displayed in the body of the report. These items
will be displayed on all the order lines of the order.

Part 4: Full application with data 209

 • The items regarding the order totals will be displayed in the page footer. Indeed, this
information must not be repeated on each line of the order. For the TotalBT_Or and TotalIOT
items, click the line corresponding to the item. In the "Block" column, expand the combo box
and select "Page footer".

The following table presents the different assignments of items in the order presented in the
wizard:
Item Block
FullName Page header
Address Page header
ZipCode Page header
City Page header
Country Page header
OrdersID Page header
Date Page header
Reference Body
Caption Body
PriceBT Body
Quantity Body
TotalBT Body
TotalBT_Or Page footer
TotalIOT Page footer

9. Go to the next step.

210 Part 4: Full application with data

 10. The wizard proposes to create a counter, a sum or a mean on the numeric items found in
the report. In this report, the calculations are performed by the query. Click the "No calculation"
button. Go to the next step.
11. This step is used to define the report layout.

We will keep the default values with the "Portrait" orientation.

Print margins
When choosing the print margins, don't forget to take into account the physical
Notes

margins of printers. The physical margins of the printer are margins where no
print is allowed. Furthermore, the physical margins differ according to the type
of printer.

12. Go to the next step.

13. This screen allows you to select the skin template used for the report. We recommend
that you use the same skin template as the one used for the windows. In our case, select the
"Gensteel" skin template for example and go to the next step.
14. All we have to do now is give a name and a title to the report.
• Enter the title: "Order form"
• The "RPT_Order_form" name is automatically proposed.

Part 4: Full application with data 211

 15. Validate.
16. The report being too large to be printed in Portrait mode, the report editor proposes to use
the landscape mode, to reduce the table or to print the table on several pages. In our case,
accept the landscape mode.
17. If necessary, accept to reduce the table.
18. The backup window of the report is displayed. Validate the backup information.
19. The report is displayed in edit in the report editor:

20. The different order lines are grouped in a table.

212 Part 4: Full application with data

To run this report, click among the quick access buttons.
1. The report editor asks for the print destination. The print destination can be:

Choose "Print preview" and validate.

2. The report editor asks for the parameters of the query used by the report. Don't forget that
a parameter was used to specify the number of the order to print. For the example, type the
test value "1".

Validate.
3. The report execution is displayed on the screen.

Part 4: Full application with data 213

 You can:
• Print the current page or the entire document by clicking the printer.
• Create a duplicate copy.
• Select a different zoom value.
• Save the report as a Word document (in RTF format).
• Save the report in HTML format.
• Save the report in PDF format.
• Save the report in XML format.
• Create an email with the report in HTML format in message body.
• Create an email with the report in PDF format in attachment.
• Write annotations in the document.
• Perform a search in a document.
• Add watermarks.
Close the print preview.

214 Part 4: Full application with data

Modifying the "Order form" report
We are going to perform modifications regarding the layout in the report that was just created.
Delete the number of pages displayed in the report:
1. Select the [PAGENUM]/[NBPAGES] control.
2. Press the [DEL] key on the keyboard.
We want to position the information regarding the customer and the order in the page header:
1. Delete the "Order form" caption found in page header.
2. Delete the captions found in front of the customer details (Full name, ...).
3. Position the item containing the city beside the zip code.
4. Select the customer details and move them (with the mouse) to the right of the report.
5. Move the order number and the order date up (to the top of the "Page header" block).
We are going to position the totals properly in the page footer:
1. Select the controls (captions and items) corresponding to the totals found in the page footer.
2. Position these controls with the mouse in the bottom right corner of the table.
Modify the print options of the "Page footer" block:
1. Display the description window of the "Page footer" block:
• Click the "Page footer" block.
• Display the popup menu (right mouse click) and select "Block description".
2. In the "General" tab, check the following options:
• Print the "End of document" block AFTER the "Page footer" block on the last page.
• The "Page footer" block is not printed at the bottom of the page, it is stuck to the previous
blocks.

3. Validate the description window.

Part 4: Full application with data 215

 4. The report is displayed in the report editor:

5. Save the report by clicking among the quick access buttons.

Our order form report is now created.

Displaying the printed report from a menu option

In our application, the "RPT_Order_form" report will be printed from an option found in the popup
menu of the Table control used to list the sought orders.
As already seen, the Table control proposes an automatic menu. We want to keep the options of
this automatic menu and add an option that will be used to print the selected order form.
The principle is as follows:
1. We are going to create a new popup menu. This menu will contain the WLanguage code used
to print the report.
2. We are going to link this popup menu to the Table control and specify that the default popup
menu will be displayed just after the popup menu defined for the Table control.

Creating the popup menu

To create a popup menu in the "WIN_Menu" window:

1. Open (if necessary) the "WIN_Menu" window in the editor (double-click its name in the project
explorer for example).
2. On the "Window" pane, in the "Bars and menus" group, expand "Popup menus" and select
"New popup menu".
3. A new popup menu appears in the editor. This menu includes a single option named "Menu
option".

216 Part 4: Full application with data

 4. Display the description of the popup menu:
• Select "Menu option".
• Display the popup menu (right mouse click).
• Select "Description of popup menu".
5. Give a name to the popup menu ("MENU_Order") and validate.

Popup menus and windows

Notes

A popup menu is associated with a window. If a window includes several popup

menus (popup menu of the window, popup menus of controls, ...), all these
menus are saved with the window.

We are now going to define the caption of the option and its code.
1. Select the "Menu option" option.
2. Press the [SPACE] key on the keyboard: the option becomes editable. Type the new caption
("Print the order form") and validate.
3. Display the code associated with the option:
• Select the option.
• Display the popup menu (right mouse click) and select "Code".
4. Type the following code:

// Print preview
iPreview()
// Initializes the report query
iInitReportQuery(RPT_Order_form, ...
TABLE_QRY_FindOrders.COL_OrdersID)
// Starts printing the report
iPrintReport(RPT_Order_form)

In this code:
• iPreview is used to specify that the report print will be performed in the print preview.
• iInitReportQuery is used to specify the parameters expected by the query associated with
the report. In our case, the query expects the order number in parameter. This order number
is found in the COL_OrdersID column of the TABLE_QRY_FindOrders Table control for the
current row.

Part 4: Full application with data 217

 • iPrintReport is used to print the specified report (the RPT_Order_form report in our case).
5. Close the code window and the window containing the popup menu.
6. Save the "WIN_Menu" window.

Associating the popup menu with the Table control

Last step: we are going to link the popup menu to the Table control.
1. In the "WIN_Menu" window, display the "Finding orders" tab.
2. Select the Table control and display its description ("Table description" from the popup
menu of the control).
3. In the "GUI" tab, expand the "Popup menu" combo box.
4. Check "Add a popup menu", select the "MENU_Order" menu and select "At the beginning" to
specify that the menu is placed before the system menu.

5. Click inside the window to validate the popup menu.

6. Validate.

Print test

Now, all we have to do is run a real test:

1. Run the test of the "WIN_Menu" window.
2. Select the "Finding orders" tab pane.
3. Specify the criteria and start a search.
4. Select one of the orders displayed in the Table control.
5. Print the order via the popup menu.

218 Part 4: Full application with data

 6. Close the print preview and the test window.

Part 4: Full application with data 219

 Lesson 4.7.  Printing a list of
customers

This lesson will teach you the following concepts...

• Creating a report with breaks

• Starting the report print

Estimated time: 20 min

220 Part 4: Full application with data

Overview
This lesson is used to print a list of customers, grouped by country and by state or province.
To do so, we are going to use a table report in order to clearly represent a list of data.

If you did not create the windows in the previous lessons, you can follow this
lesson by opening a corrected project: on the "Home" pane, in the "Online help"
Answer

group, expand "Tutorial" and select "Full application (With windows)".

A corrected project of the application is also available: on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (Answer)".

Creating the report

To create a report:

1. Click among the quick access buttons.
2. The window for creating a new element is displayed: click "Report" then "Report". The wizard
for report creation starts. The wizard for report creation proposes several types of reports:

3. Select "Table". Go to the next step.

Part 4: Full application with data 221

 4. Select the data source of the report. The report will be based on Customer file. Select "From
a data file or from an existing query". Go to the next step.

5. In the list of data files and queries, select the "Customer" file. Go to the next step.
6. Define the search key of the file. In our case, the Customer file will be browsed according to
the full name of the customer. Select the "FullName" search key. Go to the next step.

7. We are now going to define the sort option of data in the report. By default, the wizard
proposes the item used as search key in the data file. As we want to create a report used to list
the customers by country and by state, we are going to add a sort on these two items.

222 Part 4: Full application with data

 8. To add a sort on the country:
• Click the "+" button to add a sort item.
• In the window that is displayed, select the Customer.Country item.

• Validate.
9. To add a sort on the state:
• Click the "+" button to add a sort item.
• In the window that is displayed, select the Customer.StateProvinceRegion item.
• Validate.
10. Modify the order of sort items. the customers must be sorted by country, by region, then in
alphabetical order.
• The "Customer.Country" item appears in second sort item. Select this item and move it in
first sort item via the arrow buttons.
• The "Customer.StateProvinceRegion" item appears in third sort item. Select this item and
move it in second sort item via the arrow buttons.

Go to the next step.

11. The wizard asks you to specify whether a break is required.

Part 4: Full application with data 223

 What is a break?
A Break is an operation used to group the records (or rows) according to one or
more criteria. Caution, the records (or rows) will be printed.
A break must NECESSARILY be linked to a sort.
Notes

You will notice the presence of a break header and footer.

The information common to the different rows is found in the break header.
The totals, counters, ... are found in the break footer.
This break is used to group a set of records according to the same criterion. In
our example, the break is performed on the country and it is used to group all the
customers living in the same country.

12. Answer "Yes". Go to the next step.

13. Specify the sort item on which the break must be performed. In our case, we will be using
several breaks:
• the first break is performed on the country.
• the second break is performed on the province.
Uncheck the "Customer.FullName" item.

224 Part 4: Full application with data

 14. Go to the next step.
15. You are going to specify the order in which the items will be printed and how they will be
distributed in the different blocks. In our example:
• only the country will be found in the "Start of break 1" block. The "Country" item is
automatically associated with the "Start of break 1".
• only the state will be found in the "Start of break 2" block. The "StateProvinceRegion" item is
automatically associated with the "Start of break 2".
• only the FullName, Address, ZipCode, City, StateProvinceRegion and Country items will be
displayed in the report.

Uncheck the CustomerID, Complement, Phone, Cell and Email items. Go to the next step.
16. This screen is used to define the report layout.

Part 4: Full application with data 225

 We will keep the default values with the "Portrait" orientation.

Print margins
When choosing the print margins, don't forget to take into account the physical
Notes

margins of printers. The physical margins of the printer are margins where no
print is allowed. Furthermore, the physical margins differ according to the type
of printer.

17. Go to the next step.

18. This screen allows you to select the skin template used for the report. We recommend
that you use the same skin template as the one used for the windows. In our case, select the
"Gensteel" skin template for example and go to the next step.
19. All we have to do now is give a name and caption to the report and save it.
• Enter the title: "List of customers".
• Keep the name proposed by default: "RPT_List_of_customers".
20. Validate.
21. Validate in order to switch to landscape mode.
22. Validate in order to reduce the report.

226 Part 4: Full application with data

 23. The report is displayed in the report editor. Save the report.
The report is completed. Let's now run the report test to see the result.
To run this report, click among the quick access buttons.
The print destination can be:

Part 4: Full application with data 227

 Choose "Print preview" and validate.
The report execution is displayed on the screen.

You have the ability to print the current page or the entire document by clicking the printer ("Print"
pane).

Starting the report print by programming

Our report being completed, we are going to create a menu in our "WIN_Menu" window to print this
report directly.
To insert a menu into the "WIN_Menu" window:
1. Display the "WIN_Menu" window in the editor (double-click its name in the "Explorer" pane for
example).
2. On the "Window" pane, in the "Bars and menus" group, expand "Main menu" and select
"Add the main menu".
3. A menu is inserted into the window, below the title bar. This menu contains an option
named "Menu".
4. Select the "Menu" option:
• Display the popup menu (right mouse click).
• Select "Add after".

228 Part 4: Full application with data

 5. In the input area, type "Reports".

6. Select the "Reports" option:

• Display the popup menu (right mouse click).
• Select "Transform to expand a sub-menu".
7. In the input area that is displayed, type "List of customers". Press the [ENTER] key to validate.

To type the code of the "List of customers" option:

1. Select the "List of customers" option in the editor.
2. Display the popup menu (right mouse click).
3. Select "Code". The code editor appears.
4. In the "Selecting the menu" process, type the following code:
// The print is performed in a preview
iPreview()

// Prints the report

iPrintReport(RPT_List_of_customers)

Let's study this code:

• iPreview (or iDestination) is used to configure the destination of the print. You have the
ability to print:
• in a text file,
• in HTML format,
• in PCL format,
• in PDF, RTF, XLS or XML format,
• on a fax.
In our case, the print will be performed in the print preview.
• iPrintReport is used to print a report.

Part 4: Full application with data 229

 Run the test of the window (and menu options) by clicking among the quick access
buttons.
We are now going to modify this menu by adding an option used to exit from the application.
1. In the editor, select the "Menu" option.
2. In the popup menu (right mouse click), select "Transform to expand a sub-menu".
3. In the input area that is displayed, type "Exit".
4. We are going to associate this menu option with the "ALT + F4" shortcut:
• Select the "Exit" option.
• In the popup menu (right mouse click), select "Option description".
• In the "General" tab, in the "Keyboard shortcut" area, select "F4" and check "Alt".

• Validate.
5. Display the code of the option and in the "Selecting the menu" process, type the following
code:

// Asks the user whether he wants to exit from the application

IF YesNo(No,"Exit from the application?") = Yes THEN
// End of application
EndProgram()
END

Let's study this code:

• YesNo is used to establish a dialog with the user by asking him a question. The user can give
an answer to the question via 2 buttons: yes or no.
• EndProgram (called if the user clicks "Yes") is used to end the application.
Run the window test by clicking among the quick access buttons.

230 Part 4: Full application with data

 Lesson 4.8.  Statistics: Chart and
Pivot Table controls

This lesson will teach you the following concepts...

• Displaying the data in a chart

• Creating summary tables via the Pivot Table

Estimated time: 30 min

Part 4: Full application with data 231

 Overview
The presentation of statistics or summary tables is often required in a management application.
This type of presentation can be used for example to follow:
• the evolution of orders in time,
• the evolution of turnover,
• the evolution of stocks,
• ...
Any executive manager wants to get this information.
WINDEV proposes several controls allowing you to easily include this information in your
applications. Two specific controls will be used in this lesson:
• the Chart control.
• the Pivot Table control.

If you did not create the windows in the previous lessons, you can follow this
lesson by opening a corrected project: on the "Home" pane, in the "Online help"
Answer

group, expand "Tutorial" and select "Full application (With windows)".

A corrected project of the application is also available: on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (Answer)".

Displaying data in a Chart control

To handle the Chart control in real conditions, we are going to create a Chart control displaying the
status of the sales in the "WD Full Application" application.
First of all, we are going to create a query used to select the data that will be displayed in the Chart
control.

Selecting the data that will be displayed in the Chart control

To create our chart, we want to get the sum of orders by date.
We are now going to create a query used to perform a sum. Indeed, we are going to calculate the
total amount of orders (TotalIOT item in the Orders data file).
We are going to calculate the total amount of all the orders per date (the Turnover per date).
Create a new query:
1. Click among the quick access buttons.
2. The window for creating a new element is displayed: click "Query".
3. We are going to create a select query. Select the "Select" option. Go to the next step.
4. The description window of the query is displayed.

232 Part 4: Full application with data

 5. Add the Orders.Date and Orders.TotalIOT to the query:
• On the left, expand the "Orders" file.
• Double-click the Date item then the TotalIOT item.
• The two items appear in the middle of the screen (in the "List of elements found in your
query" area).
To calculate the sum of values of "Orders.TotalIOT":
1. Select the item "Orders.TotalIOT" in the middle.
2. In the "Actions", on the right, select "Sum".

3. Validate the description of the sum. The sum of "TotalIOT" was added into the list of query
result.

You will notice that the query editor of WINDEV creates the queries in everyday's
language (and also in SQL language).
Notes

This allows you to check whether your query performs the proper operations.

Part 4: Full application with data 233

 We are now going to group the data by year and to sort it:
1. Select the "Orders.Date" item in the middle.
2. In the "Actions", on the right, click "Year, Month" and select "Year".

3. Validate the window that is displayed.

4. The "Year" item is displayed in the middle of the query description.
5. Select the "Year" item and define the sort:
• Display the popup menu of the "Year" item.
• Select "Sort the item .. Sort in ascending order".
• An arrow indicating the sort appears in the query description. 
The query is created. We are going to give it a name and to save it.
1. At the top of the screen, type the name: "QRY_SalesEvolutions".
2. Type the caption: "Sum of orders by date".
3. Validate the description window of the query.
4. The backup window is displayed. Validate the proposed information.
5. The graphic representation of the query is as follows:

6. Click to run the query test.

234 Part 4: Full application with data

Creating the Chart control
We are going to include the Chart control in a new tab of the WIN_Menu window.
To create a new tab in the "WIN_MENU" window:
1. Display (if necessary) the "WIN_Menu" window in the window editor.
2. Double-click the Tab control: the description window of the control is displayed.
3. In the "General" tab, select the "Finding orders" tab pane and click the "New" button. A new
pane appears.
4. Select the new pane (named "Pane 4").
5. In the right section of the screen, type the caption of the tab pane: "Chart".
6. In the right section of the screen, select an image in the image catalog:
• Click the "Catalog" button.
• Type "Chart" in the search control.
• Select the "Flat Soft" theme and validate.
• Select for example and validate the different screens.
7. Validate the description window of the Tab control.
8. The new tab appears in the window.
To create the Chart control:
1. In the "WIN_Menu" window, select the "Chart" tab if necessary.
2. On the "Creation" pane, in the "Graphic controls" group, click "Chart". The control appears
under the mouse cursor.
3. Click the "Chart" tab. The wizard for creating a Chart control starts.

Part 4: Full application with data 235

 4. In the wizard, select a "Bar" chart. Go to the next wizard step.
5. Enter the parameters of the chart:
• the chart title: "Sales evolution".
• the legend: the chart has no legend.
• the labels must be displayed.

Go to the next step.

6. Enter the parameters of axes:
• Title of X axis: Year
• Title of Y axis: TO
Keep the default options and go to the next step.

236 Part 4: Full application with data

 7. We are now going to define the data source.
• For the labels (values displayed at the bottom of the chart, the years in our example):
• the source corresponds to: "Browsing a file or a query",
• the data corresponds to the Year item in the QRY_SalesEvolutions query.

• For the series (values displayed in the Chart control): the Chart control will display a single
series corresponding to the total IOT calculated by the QRY_SalesEvolutions query.
• Double-click the "Sources of series" table.
• Type the caption: "Series 1".
• The source corresponds to: Browsing a file or a query,
• The data corresponds to the "Sum_TotalIOT" item in the QRY_SalesEvolutions query.

Go to the next step.

8. No background image will be associated with the Chart control. Go to the next step.
9. Give a name to the Chart control: "CHART_SalesEvolutions" and validate the wizard.
10. The Chart control is automatically created in the editor.
11. Click to run the window test.

Part 4: Full application with data 237

 12. Click the "Chart" tab to view the chart.

Automatic features of Chart control (AAF)

Like the Table control, the Chart control proposes several automatic features
accessible via its popup menu.
Notes

You can for example:

• change the type of chart,
• save the chart,
• print the chart, ...

13. End the test and go back to the editor.

238 Part 4: Full application with data

 To master the use of a Chart control, don't forget to take a look at the examples
supplied with WINDEV:
Example
• Unit example: Chart control
• Training example: WD Chart
These examples are available from the home window of WINDEV (CTRL <).

Creating summary tables with the Pivot Table control

To handle the Pivot Table control in real conditions, we are going to create a Pivot Table control
used to view the sales of products per country and per year in quantity and in turnover.

As for the Chart control, we are going to include the Pivot Table control in a new tab of the WIN_
Menu window.

Part 4: Full application with data 239

 To create a new tab in the "WIN_MENU" window:
1. Display (if necessary) the "WIN_Menu" window in the window editor.
2. Double-click the Tab control: the description window of the control is displayed.
3. In the "General" tab, select the "Chart" tab pane and click the "New" button. A new pane
appears.
4. Select the new pane (named "Pane 5").
5. In the right section of the screen, enter the caption of the tab pane: "Pivot table".
6. In the right section of the screen, select an image in the image catalog:
• Click the "Catalog" button.
• Type "Table" in the search control.
• Select the "Flat Soft" theme and validate.
• Select the second proposed icon and validate the different screens.
7. Validate the description window of the Tab control.
8. The new tab appears in the window.

Creating the Pivot Table control

To create a Pivot table control:

1. In the "WIN_Menu" window, select the "Pivot Table" tab if necessary.
2. On the "Creation" pane, in the "Data" group, expand "Table and list box" and select "Pivot
table (PVT)". The control appears under the mouse cursor.
3. Click the "Pivot table" tab. The wizard for creating a Pivot Table control starts.
4. Go to the next step.
5. In the cells, we want to display the following information:
• the total amount of sales.
• the quantity sold.
We are going to select the source file in the wizard: OrderLine.
For the first information, select:
• Display: "The sum of".
• Source: "TotalIOT".
Click the "Add an additional value" button.
For the second information, select:
• Display: "The sum of".
• Source: "Quantity".

240 Part 4: Full application with data

 Go to the next step.
6. In the headers of columns, we want to display the years. In the left section, expand the
Orders file and double-click the Date item.

Go to the next step.

7. The wizard proposes a link to reach the Orders file and it proposes to display three levels of
information in header: the years, the quarters and the months.

8.  Validate and go to the next step.

Part 4: Full application with data 241

 9. In the headers of rows, we want to display the products grouped by country. In the left
section:
• expand the Customer file and double-click the Country item.
• expand the Product file and double-click the Caption item.

Go to the next step.

10. The wizard proposes a link for each row header (Customer.Country and Product.Caption).
Validate each link and go to the next step.
11. Give a name to the Pivot Table control: PVT_Sales.
12. Validate the wizard.
13. The Pivot Table control is automatically created in the window as well as a "Calculate"
button. This button allows the user to start calculating the data that will be displayed in the
Pivot Table. This button can be positioned anywhere in the window.
14. Save the window ( among the quick access buttons).

242 Part 4: Full application with data

Test of Pivot Table

Run the window test ( among the quick access buttons). Click the "Pivot table" tab then
the "Calculate" button.

CAUTION: The calculation time depends on the size of the database and on the
Notes

number of row and column headers. The result of the pivot table can be saved to
avoid re-calculating at each interrogation.

Click the "+" signs to expand the different columns and rows.
Stop the test. We are now going to improve this pivot table. Indeed, nothing indicates that one
of the numbers found in the cells corresponds to a quantity. We are going to use a specific
display mask for this value.

Part 4: Full application with data 243

 To use a display mask in a cell:
1. Display the description of the Pivot Table control (double-click the control).
2. In the "Content" tab, click "VAL_NoName2". The description of values displayed in the cells
appears.
3. In the "Mask" area, add the "Qt: " prefix.

4. Validate the description window.

5. Run the window test again.

244 Part 4: Full application with data

 Lesson 4.9.  Sending an email

This lesson will teach you the following concepts...

• How to send an email from a WINDEV application

• How to include a supercontrol in a window
• How to define the tab order in a window
• How to open a non-modal window

Estimated time: 20 min

Part 4: Full application with data 245

 Overview
Several WLanguage functions allow you to manage the incoming and outgoing emails. You also
have the ability to access the characteristics of an email:
• sender, recipients,
• outgoing date, subject, message,
• attachments...
WINDEV proposes several methods for managing the emails:
• Management via Lotus Notes, Outloook or MS Exchange:
• The Lotus Notes or Outlook messaging software: these programs allow you to send and
receive emails.
• The "Simple Mail API" (also called SMAPI or Simple MAPI): this mode for email management
is used by most of the Microsoft applications, especially by Microsoft Exchange.
• Management via the POP3, IMAP and SMTP protocols:
• The POP3 protocol: this protocol for receiving emails is recognized by all the service
providers. It is used to communicate with the server directly, available at your ISP. This
protocol is used to list the incoming messages and to read them.
• The IMAP protocol: this protocol for receiving emails is used to leave the emails on the
server so that they can be consulted from different webmails.
• The SMTP protocol: this protocol for sending email is recognized by all the service providers.
In this lesson, we are going to create a window allowing the user to send an email from the "WD
Full Application" application. This window is as follows:

246 Part 4: Full application with data

We are going to use the SMTP protocol. Indeed, this mode is commonly used all over the world.
See the online help for more details about the other methods.

To follow this lesson, you must have followed the lessons of this part until lesson
Answer

“Lesson 4.7. Printing a list of customers”, page 220.

A corrected project of the application is also available: on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (Answer)".
Example

See the "WD Email" example (complete example supplied with WINDEV) for
more details. This example can be accessed from the home window of WINDEV
(CTRL <).

A window for sending emails

This window will contain all the controls allowing the user to enter the different elements of the
email. A "Send" button will group all the processes used to send the email.

Creating the window

Create a new window:

1. Open the "WD Full Application" project if necessary.
2. Create a new blank window.
• Click among the quick access buttons.
• The window for creating a new element is displayed: click "Window" then "Window".
• The wizard for window creation starts.
• In the "Based on a template" tab, choose "Use: WINTPL_Template" and validate the wizard.
3. The backup window of the created element is displayed. The title of this window being
"Sending an email", its name is automatically proposed: "WIN_Sending_an_email". Validate
the proposed information.

Creating the controls used to configure the sending

In a first time, we are going to create all the controls for configuring the SMTP server used to send
messages. Four edit controls are required:
• SMTP server
• Port of SMTP server
• User name
• User password.

Part 4: Full application with data 247

 To create the edit control corresponding to the name of the SMTP server:
1. On the "Creation" pane, in the "Usual controls" group, click .
2. The shape of the control appears under the mouse cursor.
3. Click the top left corner of the window: the edit control is automatically created.
4. Select the control and press the [ENTER] key on the keyboard. The caption becomes
editable. Type "SMTP server" and validate.
To create the edit control corresponding to the port:
1. On the "Creation" pane, in the "Usual controls" group, expand "Edit".
2. Select a preset Integer edit control.
3. The shape of the control appears under the mouse cursor.
4. Click below the "SMTP server" control: the edit control is automatically created.
5. Select the control and press the [ENTER] key on the keyboard. The caption becomes
editable. Type "Port" and validate.
To create the edit control corresponding to the user name:
1. On the "Creation" pane, in the "Usual controls" group, click .
2. The shape of the control appears under the mouse cursor.
3. Click below the "Port" control: the edit control is automatically created.
4. Select the control and press the [ENTER] key on the keyboard. The caption becomes
editable. Type "User" and validate.
To create the edit control corresponding to the user password:
1. On the "Creation" pane, in the "Usual controls" group, expand "Edit".
2. Select a preset "Password" edit control.
3. The shape of the control appears under the mouse cursor.
4. Click below the "User" control: the edit control is automatically created.

The "Password" edit control appears in the editor with a bullet and an eye.
At run time, when the user types his password, the characters will be replaced
by bullets. A click on the eye will allow the user to see his password in clear and
Tip

to check it.
This feature can be disabled by programming if necessary. See the online help
for more details.

Align the created controls:

1. Select the four controls.
2. On the "Alignment" pane, in the "Inside and outside" group, click "Justify (Ins. and Out.)".

248 Part 4: Full application with data

 3. Save the window ( or CTRL S).

Creating the controls used to enter the characteristics of the email

To write an email, the user must have:
• A control used to enter the sender address.
• A control used to enter or select the recipient address.
• A control used to enter the email subject.
• A control used to enter the email text. The user must have the ability to format the email text.
• A control used to add attachments.
We are now going to create these controls in our window.

To create the edit control corresponding to the sender address:

1. On the "Creation" pane, in the "Usual controls" group, expand "Edit".
2. Select the preset "Email" edit control.
3. The shape of the control appears under the mouse cursor.
4. Click below the "Password" control: the edit control is automatically created.
5. Select the control and press the [ENTER] key on the keyboard. The caption becomes
editable. Type "Sender" and validate.
The control used to enter the recipient address must list the addresses of the customers
found in the database but it must also allow the user to type another address. To do so, we
will be using an "Editable combo box" control linked to the Customer data file.
1. On the "Creation" pane, in the "Usual controls" group, click "Combo box".
2. The shape of the control appears under the mouse cursor.
3. Click below the "Sender" control: the wizard for creating the Combo Box control is
automatically started.
4. Select "Display the data found in a file or in an existing query". Go to the next step.

Part 4: Full application with data 249

 5. Select the "Customer" file. Go to the next step.
6. The email addresses of customers must be displayed in the control:
• Uncheck the "CustomerID" item.
• Check the "Email" item.
Go to the next step.
7. The sort item is the "Email" item. Go to the next step.
8. The return value is the "Email" item. Go to the next step.
9. Keep the default options. Go to the next step.
10. In the "Additional parameters" screen, check "Allow the input". Indeed, the user must have
the ability to type a new email address. Go to the next step.
11. Modify the name and caption of the Combo Box control:
• The control name is "COMBO_Recipient".
• The control caption becomes "Recipient".
12. Validate the wizard. The control is automatically created in the window.
To create the edit control corresponding to the email subject:
1. On the "Creation" pane, in the "Usual controls" group, click .
2. The shape of the control appears under the mouse cursor.
3. Click below the "Recipient" control: the edit control is automatically created.
4. Select the control and press the [ENTER] key on the keyboard. The caption becomes
editable. Type "Subject" and validate.
An HTML edit control will be used for the message body: the user will have the ability to
format the text of the email via a specific toolbar.
1. On the "Creation" pane, in the "Usual controls" group, expand "Edit".
2. Select a preset "HTML text" edit control.
3. The shape of the control appears under the mouse cursor.
4. Click below the "Subject" control: the edit control is automatically created.
5. Enlarge the control in order for several lines to be visible.
6. Display the description window of the control (double-click the control).
• On the "General" tab, modify the mode for displaying the formatting toolbar. This toolbar
must always be visible.
• Validate the description window of the control.
7. Reposition the control if necessary in order for the toolbar to be displayed properly.
We are going to create a file picker allowing the user to add an attachment. Instead of
creating it from scratch, we will be using a preset edit control whose type is file. Via the popup
menu of the control ("Browse" option), the user will be able to select the file to attach.
1. On the "Creation" pane, in the "Usual controls" group, expand "Edit". The list of preset controls
proposed by default is displayed.
2. Select the "File" control and perform a Drag and Drop toward the "WIN_Sending_an_email"
window: drop the control below the "HTML text" control. The file picker is immediately created.
Align the different controls found in the window.

250 Part 4: Full application with data

We are now going to create the button used to send the emails.

Sending the email

To create the send button:

1. On the "Creation" pane, in the "Usual controls" group, click .
2. Click the location where the button will be created (at the bottom of the window for example).
3. Select the button and modify its caption (press the [ENTER] key for example). The new
caption is "Send".
4. Edit the code of this button: select "Code" from the popup menu of the button (right mouse
click).
5. Type the following codes in the "Click" process:
• the code for opening the connection and for starting the SMTP session:
MySession is EmailSMTPSession
MySession..Name = EDT_User
MySession..Password = EDT_Pass_word
MySession..ServerAddress = EDT_SMTP_Server
MySession..Port = EDT_Port
// Starts the SMTP session
IF NOT EmailStartSession(MySession) THEN
Error("Unable to connect to the SMTP server.", ...
ErrorInfo())
RETURN
END

Part 4: Full application with data 251

 This code is using an advanced EmailSMTPSession variable. The different properties of this
variable are used to define the characteristics of the SMTP session. Then, EmailStartSession
associated with this variable is used to start the session.
• the code for preparing the email:

MyMessage is Email

MyMessage..Sender = EDT_Sender
MyMessage..Subject = EDT_Subject
MyMessage..HTML = EDT_HTML_Text
MyMessage..Message = HTMLToText(EDT_HTML_Text)

// Adds a recipient
Add(MyMessage..Recipient, ...
COMBO_Recipient..DisplayedValue)

// Adds the attachment if necessary

IF EDT_File <> "" THEN
EmailLoadAttachment(MyMessage, EDT_File)
END

This code is using an Email variable. The different properties of this variable are used to
define the characteristics of the email to send. This code associates the content of the
different window controls to the properties of the Email variable.
• the code for sending the email:
// Sends the email
IF EmailSendMessage(MySession, MyMessage) = False THEN
Error("Message not sent.", ErrorInfo())
ELSE
// Message sent
ToastDisplay("Message sent", toastShort, ...
vaMiddle, haCenter)
END

The email is sent by EmailSendMessage. All you have to do is pass in parameter the variable
containing the characteristics of the SMTP session and the variable containing the
characteristics of the email to send.
If the email is sent, a Toast message is displayed, indicating that the email was sent. A Toast
message corresponds to a furtive message.
• the code for closing the SMTP session:
// Closes the SMTP session
EmailCloseSession(MySession)

This code closes the session with EmailCloseSession.

Save the window and its code ( or CTRL S).

252 Part 4: Full application with data

Window improvements
We are going to perform improvements in our window:
• Add a closing button
• Format the window via the management of anchors and the tab order.
• Start the window from the "WIN_Menu" window.

Closing the window

To add a button used to close the window:

1. On the "Creation" pane, in the "Usual controls" group, expand "Button": the list of preset
buttons is displayed.
2. Click the "Close" button.
3. Click the position where the button will be created in the window (bottom right of Send
button for example).

Formatting

To define the anchors:

• Select the "Sender", "Recipient" and "Subject" controls: these controls must be anchored in
width.
• Select the "HTML text" control: this control must be anchored in width and in height.
• Select the buttons: these controls must be anchored to the right and at the bottom.
• Select the control for file selection: this control must be anchored in width and at the bottom.
To define the tab order:
The tab order of controls is the order in which the user can enter the values in the
different window controls. The move from a control to another one is performed
when pressing the [TAB] key at run time.
The default tab order corresponds to the creation order of controls. It can be
Note

modified:
• by specifying an automatic tab order: the first control in edit will be the
control found in the top left corner of the window, the second one will be
the one found immediately to its right or below...
• by specifying a tab order by selection.

1. Display the tab order via the [F5] key.

2. Define the automatic tab order: on the "Window" pane, in the "Order" group, expand
"Navigation" and select "Define automatically".
3. The numbers are modified and they now appear in order.

Part 4: Full application with data 253

 4. Press [F5] again to make the numbers disappear.
5. Save the window ( or CTRL S).

Non-modal opening of the window

The window for email management will be opened from the "WIN_Menu" window. Its opening
mode is specific because this window must not prevent the information displayed in the "WIN_
Menu" window from being viewed.
To open the "WIN_Sending_an_email" window from the "WIN_MENU" window:
1. Display the "WIN_Menu" window in the editor (double-click its name in the "Explorer" pane for
example).
2. In the editor, expand the "Menu" option and select "Exit".
3. Display the popup menu of the "Exit" option (right mouse click) and select "Add before".
4. Type the caption of the option ("Send an email") and validate.
5. Select the "Exit" option again.
6. Display the popup menu of the "Exit" option (right mouse click) and select "Insert a
separator".
7. Display the popup menu of the "Send an email" option (right mouse click) and select "Code".
8. Type the following code:
// Opens the window for sending emails
OpenChild(WIN_Sending_an_email)

In this code, OpenChild is used to perform a "non-modal" opening of the window: the user will
be able to write an email and to see the information displayed in the main window at the
same time.

254 Part 4: Full application with data

Save the window and its code ( or CTRL S).
Run the project test ( among the quick access buttons) and check the opening of the
window for sending emails.

Part 4: Full application with data 255

 Lesson 4.10.  Identifying the user: the
user groupware

This lesson will teach you the following concepts...

• What is the user groupware?

• Integrating the user groupware
• Configuring the user groupware
• Checking the user groupware

Estimated time: 20 min

256 Part 4: Full application with data

Overview
An application can be used by several contributors with different profiles. It is often necessary to
define several access levels according to the user.
Let's take a simple example: when implementing an application for sales management, the
application proposes the following features:
• Viewing the price list
• Modifying the price list
• Entering orders
• Entering customers.
The accesses differ according to the user. Some examples:
• the administrative assistants can see the price list and create orders
• the sales people can see the price list, place orders and create new customers.
• the sales directors have access to all the options.
WINDEV allows you to easily manage these access levels in your applications via the user
groupware.
We are going to include the user groupware in our "WD Full Application" application and to
configure it.

If you did not create the windows in the previous lessons, you can follow this
Answer

lesson by opening a corrected project: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "Full application (Answer)".

Integrating the user groupware

To include the user groupware in the "WD Full Application" project:
1. On the "Project" pane, in the "Project" group, click "User groupware". The window for
configuring the user groupware is displayed.

Part 4: Full application with data 257

 2. In the "Integration" tab, two integration modes are available:
• Automatic user groupware: all the elements found in the user groupware are included in
your application. This allows you to benefit from all the groupware evolutions. Furthermore,
the skin template of the project can be applied to the groupware windows.
• Custom user groupware: all the groupware elements are included in your application via an
internal component. You have the ability to customize the different elements of the user
groupware. However, the evolutions will not be taken into account.
3. Select "Automatic user groupware".
4. Select the "Runtime" tab. Two start modes are available:
• Auto run: the groupware is run as soon as the application is started.
• Manual start: the groupware will be started by programming.

5. Keep the "Auto run" option.

6. Select the "Files" tab. This tab is used to define the format and location of the data files
found in the user groupware. In our case, we will be using HFSQL Classic data files, in the
location specified by default.

If you (or the end user) is using Windows Vista (or a more recent operating
Note

system), we advise you to select "Data directory".

7. In the "Files" tab, select "Enable the history of connections". This option allows the supervisor
to get information about the connected users.

258 Part 4: Full application with data

 8. Select the "Options" tab. This tab is used to define the identification mode of the user:
• management by the user groupware.
• use of a LDAP directory. In this case, when installing the application, the user will be able to
enter the parameters of his LDAP directory.
• use of the Windows authentication.

9. Validate. A message is displayed, indicating that a Supervisor user is created.

Part 4: Full application with data 259

 A single user exists by default, the supervisor. During the first start of the
application, connect yourself by using the name: "supervisor". You will have the
ability to define the password used by the supervisor.
Note

10. Validate this message. The user groupware is included in the application.

Let's now run the test of our application:

1. Run the project test ( among the quick access buttons). A login window is displayed.
2. Connect yourself as supervisor.
3. Define the password and give its confirmation. Validate.
4. A new menu is displayed, allowing you to run the test of the application or to configure the
application.

5. Select "Configuring the groupware".

260 Part 4: Full application with data

Configuring the user groupware
Configuring the groupware consists in defining the different users of the application as well as
their rights on the different windows and controls.

The configuration of users can be performed:

• when developing the application. The necessary data files (regarding the users
Note

and their rights) can be installed along with the application.

• when the application is installed, by the administrator of the application.

Creating the users and the groups

To configure the user groupware, we are going to create a "Test_1" user and associate this
user with the "Tests" group. Then, we are going to configure the management of rights for the
group.

To create a user:

1. Click the "New" button found below the "Users" area. The screen for entering a new user is
displayed.
2. Type the following information:
• Login: Test_1
• Name: Test_1
• Password: Test_1

By default, the password is hidden during the input. To check the

Note

password, click the icon shaped like an eye: the password appears in
clear as long as the mouse button is pressed.

Part 4: Full application with data 261

 3. Click the "Save" button. The "Test_1" user appears in the list of users defined for the user
groupware.
To create a new group of users:
1. Click the "New" button found below the "Groups" area. The screen for entering a new group is
displayed.
2. Enter the name of the group: "Tests".

3. Click the "Save" button. The "Tests" group appears in the list of groups defined for the user
groupware.

262 Part 4: Full application with data

To associate the user with the group:
1. Select the "Test_1" user in the window.
2. Drag and Drop the "Test_1" user to the "Tests" group.

3. The association is performed.

Defining the rights

We are now going to define the rights for the "Tests" group. These rights will be granted to all the
users found in the group. In our example, the users found in the "Tests" group will not be allowed
to:
• Display the window for sending emails.
• Create or modify a product.
To define the rights:
1. Click "Managing the rights" on the left of the window.
2. Select the "Tests" group.
3. Click "Next".
4. The window that is displayed allows you to select each window or report of the application.
• For each window or report, you have the ability to specify whether the element will be
accessible (or not) by the group.
• For each window, you can define whether the window controls will behave like the application
(default mode) or whether they will be disabled, invisible or grayed.
To forbid the access to the "WIN_Sending_an_email" window:
1. Select the window in the list.
2. Click the "Forbid the access" button.

Part 4: Full application with data 263

 3. The window is forbidden.
Define the rights on the "WIN_Menu" window. This window contains a menu option used to
display the window for email management as well as the "New" and "Modify" buttons.
1. Select the "WIN_Menu" window.
2. Click the "Next" button.
3. The window for configuring the rights on the window controls is displayed.
4. Switch the "BTN_Modify" and "BTN_New" buttons to "Grayed":

264 Part 4: Full application with data

 5. Switch the "Send an email" option to invisible:

6. Click the "Save" button.

7. Close the configuration window.
8. The WINDEV editor is displayed.

Application test

We are now going to run the application test by using the "Test_1" login.
1. Run the project test ( among the quick access buttons). A login window is displayed.
2. Connect yourself as "Test_1" with the "Test_1" password. Validate.
3. The application starts. You will notice that the "New" and "Modify" buttons are grayed and
that the "Send an email" option is invisible.

Part 4: Full application with data 265

 4. Exit from the application and go back to the editor.

Disabling the management of user groupware

The user groupware will no longer be used in the rest of this tutorial. Therefore, it can be disabled.
1. On the "Project" pane, in the "Project" group, click "User Groupware".
2. In the window that is displayed, in the "Integration" tab, select "No user groupware".
3. Validate.

If automatic tests are run in your application, the user groupware must be
configured in order not to use the login window. To do so, fill the "Automatic
Note

login in test mode" option in the "Runtime" tab of the window for configuring the
groupware.

266 Part 4: Full application with data

 Lesson 4.11.  Re-use code via the
external components

This lesson will teach you the following concepts...

• What is an external component?

• Creating an external component, step by step.
• Distributing an external component.

Estimated time: 30 min

Part 4: Full application with data 267

 Overview

An external WINDEV component is

a building brick that can be re-used
in an unlimited number of projects
(and therefore executables).
An external component allows you
to have an identical process with
a single source code to perform
a given operation even if this
process must be performed by
several projects.
The projects that use an external
component have access in the
WINDEV editor to the name of
objects, procedures or methods made visible by the creator of the component. The projects cannot
see or modify the source code. This ensures confidentiality and stability of the source code.
Creating an external component is child's play.
How to proceed? Proceed as usual, create your windows, procedures, classes. Then, instead of
choosing the option for creating the executable, choose the option for creating a component!
A component can contain code, windows, an analysis, data files, etc!

Five methods can be used to share "code" in WINDEV:

1. The sets of procedures
Notes

2. The classes
3. The supercontrols (via the use of a dictionary)
4. The external components
5. The internal components

Let's present some cases in which the external components can be useful.

Teamwork
A developer creates and maintains an external component that is made available to other
developers. No risk of modifications "made by mistake"!

The huge projects

The external components allow you to have several small projects as well as a central project in
which the elements found in the other projects are visible. The external components are a lot
more convenient to use than the libraries (WDL files).

268 Part 4: Full application with data

The databases accessed by several projects
When the same database is accessed by several projects, you often find inconsistencies in the
database caused by modified or old source code. By grouping the operations used to access the
database (at least in write mode) in an external component, a single source code must be checked
and maintained; therefore, the risks of database inconsistency are reduced.
Furthermore, the use of a component avoids recompiling the application when the analysis is
modified.

The processes used in several projects

Complex processes are often used in several projects. These processes can be re-used
via "sets of procedures" or "classes". In this case, the modifications may not be applied to
the different projects, making the elements no longer compatible between themselves.
Using external components prevents such out-of-sync modifications, preserves the compatibility
between projects and simplifies the common modifications.
Furthermore, the PRIVATE keyword allows you to ensure the confidentiality of your code at all levels
of the external component. When re-using your external component in another WINDEV project,
the call to a PRIVATE procedure will not be allowed but the documentation regarding the use of the
procedure will be displayed!

The ability to distribute a feature or set of features

The external components allow you to develop a feature or a set of features. Other WINDEV
developers will be able to include these features in their own projects. The developers who are
using an external component can see the component elements that are made visible. However,
the source code cannot be viewed or modified.
Your external components can be distributed (free of charge or not)!

Multi-product external component

An external component can be intended to operate in:
• a WINDEV application,
• a WEBDEV application,
• a WINDEV Mobile application,
• the three types of applications.
In this last case, WINDEV allows you to:
• include the elements coming from different products (WEBDEV and/or WINDEV Mobile) in
the same external component.
• specify the corresponding WLanguage code for each runtime platform (for example, a
window is displayed by Open in WINDEV and a page is displayed by PageDisplay in WEBDEV).

Part 4: Full application with data 269

 Step by step

Step 1: Creating an external component

We are going to create an external component from the "WD Full Application" project. This project
is used to manage orders, products and customers. This external component will be used to
immediately find out in another application the customers corresponding to a given city.
During the call to the external component, you will have the ability to:
• Pass a city in parameter.
• Retrieve a string containing the customer name and the total amount of his orders.
To avoid having to develop the code required for the component to operate, the "WD Full
Application" project contains all the necessary elements.

If you did not create the windows in the previous lessons, you can follow this
lesson by opening a corrected project: on the "Home" pane, in the "Online help"
Answer

group, expand "Tutorial" and select "Full application (With windows)".

A corrected project of the application is also available: on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (Answer)".

For the component needs, the project contains:

• a "QRY_OrdersByCity" query. This query is a query with parameters used to find out the
customers corresponding to a given city as well the total amount of their orders.
• a set of procedures "SET_Component". This set of procedures contains:
• the "GiveOrdersByCity" procedure that returns, for the city passed in parameter, a string
containing the name of the customer and the total amount of his orders.
• the "DataLocation" procedure that is used to localize the data required by the component.
• an analysis used to described the data files for storing information.
We are now going to create our component. To do so, a project configuration must be created.
The project configurations are used to create several "targets" from the same
project:
• A 32-bit application,
• A 64-bit application,
Notes

• A component,
• ...
You have the ability to choose the requested configuration at any time and to
generate in a single operation all the elements for all the configurations of a
project.

270 Part 4: Full application with data

To create a project configuration whose type is "Component":
1. On the "Project" pane, in the "Project configuration" group, expand "New configuration" and
select "External component (WDK)".
2. The wizard for creating a project configuration starts. WINDEV proposes to create a project
configuration whose type is "Component". Go to the next step.
3. Give a name to your project configuration: "CompoOrdersByCity" for example. Go to the next
step.
4. Keep the default options. Go to the next step.
5. Select the elements that will be included in the project configuration. In this example, these
elements will also be found in the component.
• Click the "None" button.
• Select the "QRY_OrdersByCity" and "SET_Component" elements.

6.  Go to the next step and validate the creation of the configuration.
7. The new configuration automatically becomes the current configuration.

Part 4: Full application with data 271

 Notes To find out and modify the current configuration, use the "Project explorer" pane.

The configuration in bold corresponds to the current configuration.

To change the current configuration, double-click the name of the configuration
to enable.

We are now going to generate our component.

1. On the "Project" pane, in the "Generation" group, click "Generate".
2. The wizard for generating the component starts. Go to the next wizard step. WINDEV lists
the elements that must be included in the component (elements specified in the configuration
and analysis).

3. Select all the elements ("All" button) and go to the next step.
4. The wizard asks you to select the component elements that will be accessible from the
client application.

272 Part 4: Full application with data

 In our example, only the set of procedures "SET_Component" will be used:

5. Go to the next step.

6. WINDEV proposes to allow the translation of the component. This feature is interesting if
your component must be used by multilingual applications.

If the option "Allow the component to be translated" is checked, the specified component
elements can be translated from the application that is using the component.
This translation will be performed via WDMSG, independent module used to check out and
check in the project messages to translate.
In this example, don't check this option. Go to the next step.
7. Choose the component languages. Our example will contain the English language only. Go
to the next step.
8. The wizard proposes to manage the different component versions. In our example, the
component was just created.
Keep the default options. Go to the next step.

Part 4: Full application with data 273

 9. Enter the information regarding the component:
• Owner,
• Caption, Copyright, ...
10. Go to the next step.
11. You have the ability to associate an image with your component. This will allow the users to
easily identify the component in the "Catalog of examples" pane. Go to the next step.
12. Specify the main overview of the component. This overview will allow the user to find out
the purpose of the component. Type for example:

13. Go to the next step. The wizard will automatically generate the documentation about the
component. This documentation can be based on the comments inserted into your source
code.
14. Go to the next step. You have the ability to modify the generated documentation.
Don't do anything. Go to the next step.
15. You have the ability to create a help file associated with your component (CHM format).
This help file will be supplied along with the component. The users will be able to access it by
pressing F1 from the code of the component.
We will not generate any help file. Go to the next step.
16. The component will not be saved in the SCM. Go to the next step.
17. All we have to do now is give a physical name to our component.

274 Part 4: Full application with data

Validate. A message indicates that the component was generated. Click "End" to validate the
message.
Well done, you have just created your first ready-to-use component!
Step 2: Using the external component
Once created, your component can be used in any other WINDEV project. Let's now see how this
component can be re-used.
To do so, we are going to create a new project and import our component into this project.
1. Close the current project: on the "Home" pane, in the "General" group, expand "Close" and
select "Close the project".
2. Validate the closing of the project and save the modifications if necessary.
3. The home window is displayed.
4. Create a new project: click "Create a project" in the home window.
• This project is a Windows application.
• This project is named "CompUse" and it has no analysis.
5. On the "Project" pane, in the "Project" group, expand "Import" and select "An external
component ... From a file".
6. In the directory of the "WD Full Application" project, select the "EXE\CompoOrdersByCity"
sub-directory, then the "CompoOrdersByCity.wdi" file. The "WD Full Application" project is
available in the "Tutorial\Exercises\WD Full Application" sub-directory.

If the component was created from the "WD Full Application (with windows)"
example, select the "EXE\CompoOrdersByCity" sub-directory then the
Notes

"CompoOrdersByCity.wdi" file. The "WD Full Application (with windows)" project

is available in the "Tutorial\Exercises\WD Full Application (With windows)" sub-
directory.

Part 4: Full application with data 275

 7. Click "Open", the description of our component is displayed. This description contains:
• On the "General" tab, the elements entered when creating the external component as well
as its location.

• On the "Details" tab, the description of the component as well as the help that was
automatically generated. This allows you to identify the re-usable elements of the
component.

The description of the component can be accessed at any time. All you have to
Notes

do is select the component in the project explorer and select "Description" from
the popup menu. In this case, you also have the ability to define the load mode
of the component.

8. Validate ("Close" button). The component is included in your project.

We are now going to create a blank window to use the component.
1. Create a blank window.
• The window title is "Customers by city".
• The window name is "WIN_Customers_by_city".
• Validate the backup.
2. Display the code associated with the window ("Code" from the popup menu).
3. We are going to call the DataLocation function of the component in the "End of initialization"
process. This function expects in parameter the path used to access the data files handled by
the component. Enter the access path to the data found in the "WD Full Application" example.
DataLocation(...
"C:\WINDEV\Tutorial\Exercises\"+ ...
"WD Full Application\Exe\Windows 32-bit Executable\")
// Specify the path of YOUR data

276 Part 4: Full application with data

 If your project is using another procedure named "DataLocation", the name of
Notes
the component procedure must be prefixed by the name of the set of procedures
used so that there is no ambiguity. The code becomes:
SET_Component.DataLocation(...

4. Close the code editor.

5. Add the following controls into the window:
• An edit control whose caption is "City" and whose name is "EDT_City".
• A Table control named "TABLE_Result" filled by programming and that includes 2 columns:
- a "Name" column of Text type.
- a "Total sales" column of Numeric type.
• A button whose caption is "Search" and whose name is "BTN_Search".
Edit the code of "BTN_Search" button. During a click on this button, we are going to run the
search procedure found in the component. This procedure:
• expects the name of the city in parameter
• returns a string in the following format: Name of customer 1 + TAB + Total sales 1 + RC +
Name of customer 2 + TAB + Total sales 2 + ...
The code of the "BTN_Search" button must:
• call the GiveOrdersByCity procedure of the component while passing the content of the
EDT_City control in parameter.
• process the returned string in order to add it into the table.
Type the following code:

sResultList is string
// Retrieves the list of customers and their orders
// for the specified city
sResultList = GiveOrdersByCity(EDT_City)
// If the list is not empty
IF sResultList <> "" THEN
// Clears the table
TableDeleteAll(TABLE_Result)
// Browses the results
FOR EACH STRING sACustomer OF sResultList SEPARATED BY CR
// Adds this customer to the table
TableAdd(TABLE_Result, sACustomer)
END
ELSE // If the list is empty
InfoBuild("No customer found for ""%1""",...
EDT_City)
END

Save your window.

Part 4: Full application with data 277

 Run the window test by clicking the "GO" button found among the quick access buttons. In the
edit control, type "Paris" (while respecting the case) and click the "Search" button. The list of
customers is displayed.

That's it! Easy, isn't it?

You know how to create a component and how to re-use it in your applications. You also have the
ability to manage the setup procedures of your components, in order to distribute them separately
from your applications for example.

Distributing an external component

Two methods can be used to distribute a component:
1. Provide the necessary files "manually", this is a "standard" distribution.
2. Create a more "professional" distribution, via the setup editor of WINDEV (WDInst).

Standard distribution
In this case, you must supply all the files required for your component to operate. These files are
created when generating the component (WDI, WDK and WDO files, images, other documents, ...).
These files will be manually copied from their source directory to the destination directory. The
WINDEV projects that use this component will find the dependent files in this destination directory.
List of files that must be supplied for a standard distribution:
• the files automatically generated by WINDEV (WDK, WDI, ...).
• the dependency files.
• the WDO file must be supplied if the component is using dependency files. This file contains
the references to the external files used in the component.

278 Part 4: Full application with data

Professional distribution
The distribution of components via a setup procedure consists in supplying a setup program to
the users of the WINDEV component. This program installs all the files required for using the
component in the directory specified by the user.
This setup mode is used to automatically manage:
• the WDO file and the setup of additional files used by the component.
• the automatic setup of necessary tools (MDAC, ODBC driver for HFSQL, ...).
• the automatic update of the data files used by the component (if necessary).
• the uninstall program of the component.

Close the "CompoUse" project: on the "Home" pane, in the "General" group, expand "Close"
and select "Close the project".
Open the "WD Full Application" project. Select (if necessary) the project configuration
corresponding to the component in the project explorer.
To create the setup, on the "Project" pane, click "Setup procedure".
The wizard for creating the setup of the component starts.
We won't go into details about the different setup modes of a component. Follow the instructions
given by the wizard. See the online help (keyword: "External Component, Distributing a component")
for more details.

Part 4: Full application with data 279

 Lesson 4.12.  Consuming a Webservice

This lesson will teach you the following concepts...

• Overview
• Importing and consuming a Webservice

Estimated time: 15 min

280 Part 4: Full application with data

Overview
In most cases, an XML Web service is defined as an application accessible via the standard
Internet protocols. More specifically, the Web services allow several computers connected via
Internet to interact between themselves.
The Web services allow you to run procedures and processes on a remote Web server (.NET or
J2EE) from a client computer.

With WINDEV, these Web services can be used as client, via the SOAP protocol on HTTP (the
standard Internet protocol for transferring HTML pages), with the SOAPxx, DotNetxx and J2EExx
functions.

Regardless of the platform of the Web server (.NET, J2EE, ...), a Web service is accessible via the
SOAP protocol.
Notes

With WINDEV, you don't even have to be an expert in this field. A wizard takes
care of ("almost") everything!

Practical example
A Webservice specific to the Tutorial allows you to check the different operations that can be
performed on a Webservice.
Included in the "WD Full Application" project, this Webservice is used to interrogate a supplier
database to check the availability (stock) of a product from its reference.
In a first time, the Webservice will be imported into the "WD Full Application" project then it will be
used in the application to check the availability of the product from a Product form.

Importing a Webservice

Close the current project if necessary. The home window is displayed.

In the home window, click "Tutorial" and select the project named "Full application (Exercise)".
The project is loaded.
Tip: if the home window is not displayed, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "Full application (Exercise)".

If you did not create the windows in the previous lessons, you can follow this
lesson by opening a corrected project: on the "Home" pane, in the "Online help"
Answer

group, expand "Tutorial" and select "Full application (With windows)".

A corrected project of the application is also available: on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (Answer)"

Part 4: Full application with data 281

 Position (if necessary) on the "Windows 32-bit executable" configuration: in the project
explorer, double-click "Windows 32-bit executable" in the "Configurations" folder.
To import a Webservice into the project:
1. On the "Project" pane, in the "Project" group, expand "Import" and select "A Webservice".
2. The import wizard starts. Go to the next step.
3. Specify the address into which the WSDL description of the Webservice must be imported:
http://examples.WEBDEV.info/WSTUTORIAL_WEB/awws/WSTutorial.awws?wsdl
Reminder: this Webservice is used to interrogate a supplier database to check the availability
(stock) of a product from its reference.

4. Go to the next step. The Webservice is imported.

5. Validate the information window. The imported Webservice is found in the "Webservices"
folder of the project explorer.

282 Part 4: Full application with data

Let's take a look at the information displayed in the project explorer:

The structure includes:

• the name of the Webservice (WSTutorial in this example),
• the name of each function (ProductInStock in this example)
• the name of a structure containing either the call parameters (ProductInStock in this example),
or the return values (ProductInStockResponse in this example).
• the name of each variable found in the structure (sProductReference in this example).

In our example, the imported Webservice is named: WSTutorial. It contains 1 function:

ProductInStock.
The ProductInStock function contains 2 structures:
• ProductInStock
• ProductInStockResponse

The ProductInStock structure contains a sProductReference variable corresponding to the value

that must be passed in parameter for the call to the ProductInStock function.

The ProductInStockResponse structure contains a variable (ProductInStockResult) corresponding

to the return value of the function.

Part 4: Full application with data 283

 Consuming a Webservice
In our "WD Full Application" example, the call to the Webservice will be included in the tab used to
see the list of products. A button "In stock?" will be used to check the availability of the product via
the Webservice.
To use the Webservice:
1. Open the "WIN_Menu" window in the window editor (double-click its name in the project
explorer for example).
2. Add a button into the "List of products" pane:
• On the "Creation" pane, in the "Usual controls" group, click .
• In the window, click below the "Modify " button.
• The button is automatically created.
3. Modify the characteristics of the button ("Description" from the popup menu). This control is
named "BTN_InStock" and its caption is "In stock?".

4. Display the processes associated with the button ("Code" from the popup menu).
5. Type the following code in the "Click on BTN_InStock" process:

// Displays the response of the Webservice

InfoBuild(...
"Number of ""%1"" products in stock: %2",
COL_Reference, ProductInStock(COL_Reference))

Let's study this code:

• The ProductInStock function of the WebService is called.
• The response is formatted and displayed.
6. Close the code editor and save the window ( or CTRL S).

We are going to check the operating mode of the Webservice:

1. Run the project test ( among the quick access buttons).
2. Click the "List of products" tab if necessary.
3. Select any product in the Table control and click the "In stock" button?".

284 Part 4: Full application with data

 4. Validate the information window and close the application.

Part 4: Full application with data 285

 Lesson 4.13.  Monitor the evolution of
your applications

This lesson will teach you the following concepts...

• What is the dashboard?

• Automatic tests

Estimated time: 20 min

286 Part 4: Full application with data

Overview
The project dashboard is a main element for managing the WINDEV projects. The project
dashboard gives an overall view of the progress status of a project.
The dashboard includes several elements (Widgets) that give an overall view of the status of a
project.
In this section, we will present the operations that can be performed on the dashboard elements
as well as the management of automatic tests and the optimization of queries.

If you did not create the windows in the previous lessons, you can follow this
lesson by opening a corrected project: on the "Home" pane, in the "Online help"
Answer

group, expand "Tutorial" and select "Full application (With windows)".

A corrected project of the application is also available: on the "Home" pane, in
the "Online help" group, expand "Tutorial" and select "Full application (Answer)"

To display the project dashboard (if not already done), on the "Project" pane, in the "Project"
group, click .

The dashboard

The project dashboard includes several Widgets. Each Widget displays various information about
the project.
For example, the "Performances" Widget is used to start the performance profiler or to open the
last performance report.
The "Static audit and Compilation" Widget is used to quickly see whether the project contains
compilation errors.
You have the ability to enable (or not) a Widget, to add one or to delete one at any time.

Part 4: Full application with data 287

 Automatic tests
One of the most interesting features of the dashboard is to give information about the tests that
have been run on the application.
Several tests have already been run while developing our application.
The automatic tests are a category of specific tests. The automatic tests are used to automatically
perform some operations on your windows. These tests are recorded as WLanguage scenarios
and they can be easily modified in the code editor. Once recorded, the automatic test can be
re-run as many times as necessary, to test for example the impact of a modification made to a
window, a procedure, ...
Let's give it a try! We are going to create an automatic test on the edit window that was created at
the beginning of this lesson.
Note

The automatic tests can be run on the windows, procedures, classes.

To create an automatic test on a window, all you have to do is run the test of the window:
1. Open the "WIN_Menu" window in the editor.
2. On the "Automatic tests" pane, in the "Tests" group, expand "New" and select "Save a new
scenario".
3. In the window that is displayed, click "Start recording".
4. The test of the window is run.
5. Click the "Finding orders" tab.
6. Choose the "Credit card" payment mode.
7. Click the "Find" button.
8. Close the window via "Menu .. Exit" and confirm the end of the application.

This option may not be available if you did not follow the entire tutorial. In this
Note

case, click the cross to close the window.

9. The test is ended.

10. The test editor proposes to save a description for the test. the test is named "Test for
finding orders". Validate.

288 Part 4: Full application with data

 11. The test editor displays the WLangage code of the test that was just saved:

The test is available and it was not run ( in front of the name of the test in the editor).
12. The test can be run at any time:
• Select the name of the test in the test editor.
• In the popup menu (right mouse click), select "Run".
13. The test is automatically run and the test editor displays the result in a new window (the
test was successfully run in our case).
14. Validate the test result and save the test if necessary.

The WLanguage functions used to run automatic tests are the EmulateXXX
Note

functions.

We are now going to perform a modification in our window and to run the test again. The
modification affects the "Find" button. We are going to gray it.
1. Display the "WIN_Menu" window if necessary.
2. In the editor, click the "Finding orders" tab and select the "Find" button.
3. Display the description of the "Find" button ("Description" from the popup menu).
4. In the "GUI" tab, select "Grayed".
5. Validate the description window of the control.
6. Save the window.
7. Go back to the test editor (click the corresponding button in the bar of opened elements).
8. Run the test again.
9. The result window of the test indicates that the test is in error. Validate this window.
10. Redisplay the "WIN_Menu" window in the editor.
11. Display the description of the "Find" button ("Description" from the popup menu).

Part 4: Full application with data 289

 12. In the "GUI" tab, select "Enabled".
13. Validate the description window of the control.
14. Go back to the test editor (click the corresponding button in the bar of opened elements).
15. Run the test again. The test is now successfully run.

Another feature of the test editor is the ability to modify or add WLanguage code in the test
scenarios. We are going to add code lines to check whether the Table control contains at
least one record.
1. Display the test editor if necessary (double-click "TEST_Menu" in the project explorer for
example).
2. Add the following code before the line "EmulateMenu("_Menu","OPT_Exit")":
// If the table control contains no record
IF WIN_Menu.TABLE_QRY_FindOrders..Occurrence = 0 THEN
// An error must be signaled
TestWriteResult(twrError, ...
"The Table control is empty after search")
END

3. Save the test.

4. Click . The test is successfully run.

290 Part 4: Full application with data

The test editor proposes several features that will not be presented in this tutorial:
• the ability to use a set of test values.
• the definition of input and output parameters for the test.
• the ability to create a test library to run the test of an executable on a computer other than
the development computer for example.
See the online help (keyword: "Automatic test") for more details.
Close the editor of automatic tests.

Part 4: Full application with data 291

 Lesson 4.14.  Deploying the application

This lesson will teach you the following concepts...

• Creating the executable

• Help about new features
• Creating the setup

Estimated time: 30 min

292 Part 4: Full application with data

Overview
A full application was created, allowing you to discover several WINDEV features. We must now
generate the executable and install the application on the user computers. That's what we are
going to do now. So, you will be familiar with the main topics for developing a WINDEV application.

If you did not perform the operations in the previous lessons, you can follow this
Answer

lesson by opening a corrected project: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "Full application (Answer)"

Creating the executable

Creating the executable is child's play: a menu option and a few mouse clicks are sufficient.
We will now present in details the different steps for creating the executable. You have the ability
to click the green button at any time to validate all the wizard screens.

To create the executable:

1. In the area of quick access buttons found in the ribbon, expand the wheel and select
"Generate the 32-bit Windows executable (.exe)".

WINDEV also allows you to create 64-bit executables, Linux executables,

Note

services, Java applications, ...

2. The wizard for executable creation starts.

Part 4: Full application with data 293

 3. Describe the general options of the executable:
• the executable name: we will keep the default name.
• the name of the icon associated with the executable: you can select an icon found in the
image catalog.
• the splash screen. Several types of splash screen are available. A splash screen with
animated text is selected by default. The "Options" button is used to configure it.

Choose "No splash screen" and go to the next step.

4. For the operating mode of the executable, we will keep the default options. Go to the next
step.
5. You have the ability to customize the error message of the application. We will keep the
message proposed by default. Go to the next step.
6. The wizard proposes to enable the telemetry in the application. We won't be using this
feature. Go to the next step.

The telemetry allows you to get detailed statistics about the use of your
application by the end users. The telemetry returns various information
Note

about your deployed applications, giving you the ability to improve them.
See the online help for more details about implementing and configuring the
telemetry.

294 Part 4: Full application with data

 7. This step is used to specify whether the executable will take the patches into account.

When a modification is performed in the application, to avoid having to

provide the entire executable, the additional resources (windows, reports, ...)
can be supplied as patches. These patches are additional libraries.
If the option "Yes, the executable will take these updates by patch into
Note

account" was checked when creating the executable, the elements found
in the patch will replace the elements found in the application library when
starting the application.
See the online help for more details.

We will keep the default options. Go to the next step.

8. This step is used to manage the executable languages. The multilingual feature will be
presented in another lesson. We will keep the default options. Go to the next step.
9. This step displays all the files that will be included in the executable library. Those are the
project elements that can be handled by the end user. We will keep the default options. Go to
the next step.
10. This step concerns the directory of HFSQL Classic data files used by the application.

Select "Automatic (recommended)" if necessary. This option is used to install the data files:
• in the directory of the application data (if the executable is installed in "Program files").
• in the executable directory.
11. Go to the next step.

Part 4: Full application with data 295

 12. We are now going to enter the executable information. This information is displayed in the
Windows explorer by selecting the file properties.
Enter the following information for example:

This step can also be used to sign the executable if necessary.

Go to the next step.
13. This step concerns the version number of the executable. You can use:
• a format compatible with the earlier WINDEV versions,
• a standard Windows format. Select this option.
14. Go to the next wizard step.
15. We are now going to define the options for integrating the WINDEV framework.

296 Part 4: Full application with data

 The framework corresponds to the different libraries required for the

Note
executable to operate.

The option "Framework DLL beside the executable" allows you to use the necessary libraries
only. These DLLs are copied into the executable directory.
The option "Framework included in the executable" allows you to distribute the executable
only (the DLLs being found in the executable).
The option "Common framework" allows you to use the framework common to all the WINDEV
applications installed on the computer. With this option, the framework is installed once only
on the computer (it can also be downloaded by Internet) and it is used by all the WINDEV
applications.
16. Select "Common framework" and choose "Common WINDEV framework".
Go to the next step.
17. This step concerns Windows Vista (and later). You have the ability to include a manifest for
a use in Windows Vista (and later).
For our example, check the option "Don't include a manifest for Windows Vista and later".
Go to the next step.
18. WINDEV proposes to perform a backup of the project. This backup is used to keep a
version of the project whenever the executable is created. In our case, select "No: don't save
the project" and validate the wizard.
19. The executable is created. It can be run immediately to check its operating mode. To do so,
click the "Run the executable" button.

That's it, the executable creation is ended. A lot of options to fill but after a first configuration of
your choices, you will be able to validate all the wizard steps from the beginning.

You also have the ability to click the steps specified in the wizard in order to
Note

reach a wizard screen directly. The default options of the other screens will be
automatically validated.

Part 4: Full application with data 297

 Creating the setup
Creating the setup program is child's play: a wizard helps you define the main choices. You also
have the ability to use the setup editor if the options proposed by the wizard are not suitable. Its
use will not be presented in details in this lesson. See the online help for more details.
We will now present the different steps for creating the setup program. You have the ability to click
the green button at any time to validate all the wizard screens.

To create the setup program:

1. On the "Project" pane, in the "Generation" group, expand "Setup procedure" and select
"Create the setup procedure". The wizard for creating the executable and the setup starts.
2. The executable was already created: the selected options are stored.
3. In the wizard, click "Complements" found in the "Executable" section.
4. The wizard proposes to perform a backup of the project. Select "No: Don't save the project"
and go to the next step.
5. The wizard proposes to create the page of new features.

This option is used to create a help file in order to present the new features of the version to
the end users. During a first setup, this file can correspond to the help of the software.
Select "Create a documentation for the new features" and go to the next step.
6. You have the ability to define the elements that will be automatically included in the help
file. Keep the default options and go to the next step.

If the application already contains a help system, it can be used in order to

Note

include a page for the new features.

298 Part 4: Full application with data

 7. Validate the message. The executable is automatically created (with the options defined
when creating the executable) as well as the help system. You now have the ability to enter
specific information in the help system. In the example, leave the information created by
default. To resume the creation of the setup program, click "Continue the creation of the
setup procedure".

The help is automatically compiled.

8. Let's now go to the "Setup" section of the wizard. In this first screen, choose the setup
mode:
• Individual setup for an independent application, installed and started on each computer. We
will choose this option.
• Setup with automatic update, for a setup on a server. The applications will be installed from
the server. In case of update, only the server must be updated. The applications installed
on the computers will be automatically updated.
Go to the next step.
9. Choose a standard setup. Go to the next step.
10. We will not change the default setup directory. Go to the next step.
11. Keep the files proposed in the list of installed files. By default, WINDEV proposes the
Executable file and the help file (created by the help of new features). We are going to add the
data files:
• Click the "Add" button. The Windows explorer displays the content of the generation directory
of the application.
• Select the Customer, Orders, OrderLine, PaymentMode and Product data files (files with ".
fic", ".ndx" and ".mmo" extension).
• Validate. The files are automatically positioned in the common data directory.

Part 4: Full application with data 299

 12. Go to the next step.
13. Uncheck all the options in the database parameters. Go to the next step.
14. Keep the following options in the additional modules:

300 Part 4: Full application with data

 We are going to choose the optional tools to install and we are going to include the
uninstaller. The uninstaller will allow the users to uninstall the application from the program
manager of Windows. Go to the next step.
15. We will select WDOptimizer. This tool is used to optimize the data files of the application
on a regular basis.
16. Click "Medium" on the left of the wizard. The setup will be generated in a single directory.
By default, the setup program is created in the "Install" sub-directory of the project. You can:
• Specify a password for the setup. In this case, only the user who knows the password will be
able to install the application.
• Sign the setup with a certificate. This option is used to ensure the integrity of the setup
pack.
17. Validate. The setup program is automatically created.
18. A screen is displayed, allowing you to check the setup or to open the generation directory.

Installing an application
In the window for the end of setup creation, click the "Test" button. If this window was closed, run
the "Install.exe" program found in the directory of the setup program. The setup of the application
starts.
We are going to follow the different steps of the setup program for the "WD Full Application"
application.
1. If you are using an operating system corresponding to Windows Vista (or later), a window
requests the authorization to run the program. Validate this window.
2. Choose the language of the setup program and click "OK".

3. The setup wizard starts. Two setup modes are available:

• Quick setup: The setup is performed with the parameters specified by the application
provider.
• Custom setup: The wizard asks the user for the setup parameters of the application.

Part 4: Full application with data 301

 4. Choose "Custom setup". The wizard asks for the setup directory of the application.

5. Validate the setup directory of the application.

6. Go to the next step and end the application setup.
7. The setup of the application starts.

The different types of deployment

We have performed a simple deployment of an application. In the wizard for setup creation,
WINDEV also proposes setups with automatic update.

Overview
Several setup modes are available for a WINDEV application:
• Stand-alone setup:
This type of setup is used to create a single setup program.. This setup program will be run by
the end user on his computer.
To update the application, all you have to do is re-create a setup of the application. Then, the
end user will have to install this new program.
This is the type of setup that was just performed.
• Setup with automatic update:
This type of setup is used to automatically detect the updates when starting the application. If
an update is available, the user can perform this update immediately.
This type of setup is available both via network or via the Web. You also have the ability to
perform a multi-site setup.
We are now going to present the operating mode of a setup with update.

302 Part 4: Full application with data

Setup with network update
The creation of the setup program is performed via the wizard for creating the setup program
("Setup procedure" option in the "Project" pane).
The setup program obtained at the end of the wizard includes two setups:
• the setup of the reference application. The reference application must be installed on the
network (in a shared directory or on a server for example), accessible to all the end users of the
application.
• the setup of the application itself. This setup is included in the reference application. It can be
accessed once the reference application is installed.

The diagram below presents the setup mode of an application that is using a local HFSQL Classic
database, with a network update.

The version of the reference application is automatically checked whenever the application is
started by the end user. If this version was modified (if the reference version was updated for
example), an update is automatically proposed for the final application.

Part 4: Full application with data 303

 304
ADMINISTRATOR SERVER(S) USERS

Computer of Server of User

Part 4: Full application with data

LOCAL NETWORK
network administrator reference computers

Reference
version
Request
of setup
WinDev
application
Executable of
user setup

Database
Setup Run the Run the HFSQL Classic
Control Center
support setup user setup (Optional)
applications
(CD,DVD,USB...) multi-user (optional)

The reference server can correspond to a shared directory.

During the setup, the network administrator chooses to install (or not) the Control Center of network applications.
The setup request is performed by the User Control Center or the setup path supplied by the network administrator.
The HFSQL Classic database can be installed or created by programming.
Setup with Internet update
The same principle is used by the setup with Internet update.
The creation of the setup program is performed via the wizard for creating the setup program
("Setup procedure" option in the "Project" pane).
The setup program obtained at the end of the wizard includes:
• the setup of the reference application and the Web page used to download the client setup.
These elements must be installed on an HTTP server.
• the setup of the application itself. This setup is included in the reference application. It can be
accessed once the reference application is installed, via the Web page for download.

The diagram below presents the setup mode of an application that is using a HFSQL Client/Server
database, with an update by Internet.

Note: This type of setup can also be performed via the PCS CLOUD (if you have an account).

Multisite setup
The multi-site setup combines:
• a reference network setup deployed on a local network.
• an HTTP setup used to update the reference setup on the local network.

Part 4: Full application with data 305

 306
ADMINISTRATOR SERVER(S) INTERNET USERS

Computer of HTTP User

the network server Download
computers n
administrator page

Reference
version
Request The user displays
for setup the download WinDev
Executable page Application
of user
setup

Part 4: Full application with data

Setup media Run the
(CD,DVD,USB...) setup Download
page Download and
install application

HFSQL
Client/Server server

Manta server

Manta Manager

The HTTP server and the HFSQL Client/Server

server can be installed on the same computer.
HFSQL Client/
Serveur database
The HFSQL Client/Server database can be
(Optional) installed or created by programming.
During the setup, the network administrator
chooses to install (or not) the HFSQL Control Center.
HFSQL
The download page can be accessed via:
Control Center - the User Center Control
(Optional) - the address supplied by the network administrator
 Lesson 4.15.  Distribute "Reports and
Queries" with your applications

This lesson will teach you the following concepts...

• What is "Reports & Queries" used for.

• How to distribute "Reports and Queries".
• How to use "Reports and Queries".

Estimated time: 10 min

Part 4: Full application with data 307

 Overview of "Reports and Queries"
"Reports & Queries" allows the users to modify and create the reports and queries found in your
applications.
A user thinks that an information is missing in the standard report? "Reports and Queries" allows
the user to add this information from the print preview directly. This modification can be useful to
the other users? The report can be made available to all the users who are using the application
in network. Same for the queries.

"Reports and Queries" is free and it can be distributed with your applications
Notes

developed with WINDEV. See the license for more details about the distribution
and use conditions.

Starting "Reports and Queries"

In order for the end users to customize the reports of your application or to create their own
reports and their own queries, all they have to do is start "Reports & Queries".
To allow the end users to start "Reports & Queries":
• display your reports in the preview window. The end users will be able to start "Reports and
Queries" by clicking .
• add the automatic help menu ‘?’ into the main window of your application: on the "Window"
pane, in the "Bars and menus" group, expand "Main menu" and select "Add the ‘?’ menu".
In the wizard for creating this menu, check "Create, modify a report" and "Create, modify a
query".
• use RunReportsAndQueries in your application.

Distributing "Reports and Queries" with your applications

To distribute "Reports and Queries" with your own WINDEV application, you must:
• specify in the project that the application allows "Reports and Queries" to be run.
• in the analysis, define (if necessary) the files and items that can be used in "Reports and
Queries".
• define the reports and queries that can be modified in "Reports and Queries".
• create the executable and the setup program including "Reports and Queries".
We are going to present these different steps in details by using the "WD Full Application" project.

If you did not perform the operations in the previous lessons, you can follow this
Answer

lesson by opening a corrected project: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "Full application (Answer)".

308 Part 4: Full application with data

Configuring the project

To use "Reports and Queries" from your application, you must configure the project
associated with your application.
1. Open the "WD Full Application" example project if necessary: on the "Home" pane, in the
"Online help" group, expand "Tutorial" and select "WD Full Application (Exercise)". The project is
loaded.

If the reports have not been created in the "WD Full Application" project, open
Notes

the corrected project of the application: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "WD Full Application (Answer)".

2. Display the project description.

Reminder: To display the project description, on the "Project" pane, in the "Project" group,
click "Description".
3. In the "Advanced" tab, check "Allow to start "Reports and Queries"".

4. Validate.

Configuring the analysis

We are going to open the analysis in order to configure the files and items that can be used in
"Reports and Queries".
Open the analysis of your project: click among the quick access buttons of the WINDEV
menu.
By default, all the data files and all their items are visible and they can be handled by
"Reports and Queries". If your application contains sensitive information (passwords, ...),
these data files or these items can be made invisible in "Reports and Queries".

Part 4: Full application with data 309

 "Reports and Queries" does not allow the user to add, modify or delete records
Notes
(HAdd, HModify and HDelete are not allowed). No data file can be created or re-
created (HCreation and HCreationIfNotFound are not allowed).

To define an invisible file in "Reports and Queries":

1. In the data model editor, select the requested data file.
2. Display the description window of the file ("Description of data file" from the popup menu).
3. In the "Reports and Queries" tab, uncheck "Visible by the end user, in "Reports and Queries"".
4. Validate.
To define an invisible item in "Reports and Queries":
1. In the data model editor, select the requested data file.
2. Display the description window of the file ("Description of items" from the popup menu).
3. Select the requested item in the table.
4. In the "Reports and Queries" tab, uncheck "Visible by the end user, in "Reports and Queries"".
5. Validate.
To take into account the modifications performed in the analysis, you must regenerate the
analysis ("Generation" option in the "Analysis" pane). An automatic modification of data files
is proposed to take the modifications into account.

Configuring the reports

When creating a report, you have the ability to specify whether this report can be modified in
"Reports and Queries".
To allow the "RPT_Table_QRY_FindOrders" report (found in the "WD Full Application" project)
to be modified in "Reports & Queries":
1. Open the "RPT_Table_QRY_FindOrders" report in the report editor.
2. Display the report description ("Report description" from the popup menu).
3. In the "Options" tab, check "Report modifiable in Reports and Queries".
4. Check:
• "Modifiable interface" in order for the interface of the report to be modifiable in Reports and
Queries.
• "All modifiable (interface and code)" in order for the entire report to be modifiable in Reports
and Queries.

310 Part 4: Full application with data

 5. Validate and save the report.

Configuring the queries

By default, a query can be modified in "Reports and Queries".
To allow the "QRY_OrderForm" query (found in the "WD Full Application" project) to be
modified in "Reports & Queries":
1. Open the "QRY_OrderForm" query in the query editor.
2. Display the description of the query ("Query description" from the popup menu of the query
graph).
3. Click the "Advanced" button (found among the "Actions").
4. In the "Reports and Queries" tab, check "Visible in Reports and Queries".
5. Validate and save the query.

Creating the executable and distributing the application

The method for creating and distributing an application that is using "Reports and Queries" is the
same as the method for creating and distributing a standard application. You have the ability to
specify the parameters specific to "Reports and Queries" when creating the setup procedure.
To create the setup program of your WD Full Application application:
1. On the "Project" pane, in the "Generation" group, click "Setup procedure". The wizard for setup
creation starts. Click the "Setup" link on the left of the wizard.

Part 4: Full application with data 311

 2. Select "Create the executable now". The executable is created.
Notes
If the wizard proposes to create the help file, validate the different messages.

3. The wizard for setup creation starts.

4. Choose an "Individual setup". Go to the next step.
5. Choose a "Standard setup". Go to the next step.
6. Validate the proposed setup directory and go to the next step.
7. In the screen named "Files installed", select if necessary the data files (.fic, .mmo and .ndx)
found in the directory of the executable. To do so, click "Add" and select these files.

8. Click the "Additional information" link on the left.

9. In the screen named "Additional modules", make sure that "Include the setup of Reports
and Queries" is checked.
10. In the screen named "Reports and Queries":
• Specify whether the setup of "Reports and Queries" must be included in your setup program.
In this case, the setup package of "Reports and Queries" (found in the "Reports and
Queries" sub-directory of the setup directory of WINDEV) will be used.
You can:
• Propose to install "Reports and Queries" with the application.
• Propose to install "Reports and Queries" wen it is first used.
Caution: Including "Reports and Queries" significantly increases the size of your setup (about
270 MB).

312 Part 4: Full application with data

 • Specify (if necessary) the directories corresponding to the reports and queries modified or
created by the end user.
• The directory of custom reports and queries corresponds to the directory of the reports and
queries visible by the user who created them.
The directory of shared reports and queries corresponds to the directory of the reports and
queries visible by all the users of the application.
These directories can be modified when installing the application: all you have to do is check
"Allow these directories to be modified during the setup".
11. Click "Medium" on the left of the wizard.
12. Validate the wizard. The setup program is generated. Don't close the window indicating the
end of setup creation.

Installing and using "Reports and Queries"

Installing the application

To check the setup and use of "Reports and Queries", we are going to install the "WD Full
Application" application.
The setup program of this application was generated in the previous paragraph. The setup
program was created in the "Install" sub-directory of the current project.
In the window for the end of setup creation, click the "Test" button. If this window was closed,
run the "Install.exe" program found in the directory of the setup program. The setup of the
application starts.
We are going to follow the different steps of the setup program for the "WD Full Application"
application.
1. If you are using an operating system corresponding to Windows Vista (or later), a window
requests the authorization to run the program. Validate this window.

Part 4: Full application with data 313

 2. Choose the language of the setup program and click "OK".
3. The setup wizard starts. Two setup modes are available:
• Quick setup: The setup is performed with the parameters specified by the application
provider.
• Custom setup: The wizard asks the user for the setup parameters of the application.
4. Choose "Custom setup". The wizard asks for the setup directory of the application.
5. Validate the setup directory of the application.
6. The screen named "Reports and Queries" is used to install "Reports and Queries" (only if
this program is not already installed on the current computer).

7. Go to the next step.

8. The next screen allows you to define the directories that will be used to save the reports and
queries (if the option "Allow these directories to be modified during the setup" was checked in
the wizard for creating the setup program).

9. Go to the next step and end the application setup.

10. The application setup, then the setup of "Reports and Queries" start.

314 Part 4: Full application with data

Application test
We are now going to take the place of the end user of your application (not easy, but worth a try).
To run the application test:
1. Start the "WD Full Application" application.
2. Select "Reports .. List of customers". The report is displayed in "Print preview" mode.

3. Two new icons are displayed on this screen:

Used to modify the current report in the print preview.

Used to create a new report.

We are going to modify this report:
1. Click .
2. The report appears in edit in "Reports and Queries".

Part 4: Full application with data 315

 3. The user can perform the requested modifications:
• on the style of the displayed information (change the color of a control for example).
• on the content of the report (add a control for example). If the report is linked to a query, the
user can modify this query.
If the report is linked to an embedded query, the modification is performed in the report
directly.
If the report is linked to an independent query, the query is also modified. The modification
will be taken into account when running the report (if a window is also using this query, the
modification will not be taken into account by the window).
In this example, we want to highlight the date in red. To do so:
1. Select the date control in the start of document.
2. On the "Modification" pane, in the "Fast edit" group, click the "Color" icon and select the red
color.
3. Save your report. The directory proposed by default corresponds to the setup directory of
your application.
4. Close "Reports and Queries".
5. Select "Reports .. List of customers" in the application. The report is displayed in "Print
preview" mode and the modification becomes effective.
In this example, the modified report is available to you only. For a network application, the user
has the ability to make a modified report available to all the users.
You are now familiar with "Reports & Queries". See the online help (keyword: Reports and Queries)
for more details.

316 Part 4: Full application with data

Conclusion
The development step of our application is ended. The following lessons will allow you to discover:
• how to transform your application into a multilingual application,
• how to include your application in the Source Code Manager (SCM).

Part 4: Full application with data 317

 Lesson 4.16.  Managing the
multilingual feature

This lesson will teach you the following concepts...

• What is a multilingual application?

• Creating a multilingual application, step by step.

Estimated time: 20 min

318 Part 4: Full application with data

What is a multilingual application?
A multilingual application is an application that can be run in different languages (English, French,
German or any other language).
Therefore, the same application can be used in several languages. How is it possible?
That's what we shall see in this lesson.
We are going to handle a project that can be run in English or in French, according to the user's
choice.
The main steps of a multilingual application are:
• Choosing the project languages.
• Localizing the analysis.
• Localizing the project elements (windows, reports, controls, help system, ...).
• Localizing the messages found in the code.
• Programming the change of language in the application.
These different steps will be applied to the "WD Full Application" project. This project, available in
English, will be translated into French.

If you did not perform the operations in the previous lessons, you can follow this
Answer

lesson by opening a corrected project: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "Full application (Answer)"

Choosing the project languages

The first operation consists in choosing the project languages.

1. Display the project description: on the "Project" pane, in the "Project" group, click "Description".
2. Click the "Languages" tab. Our application will support English and French.
3. Click the "Add" button. The window for selecting languages is displayed.

Part 4: Full application with data 319

 4. Click "French". A checkmark is displayed on the right of the language.
5. Validate. The "French" language appears in the list of project languages.
The "Languages" tab can also be used to configure the linguistic options regarding the
numbers, the currencies, the dates, ... for the selected language. Let's see an example:
1. Click the "French" language.
2. Select the "Date" tab.
3. The linguistic options of Windows are used by default. Select "Use the following parameters":
you now have the ability to define the date format as well as the translation used for the days
and months.
4. Keep the option "Use the settings defined in the linguistic options of the operating system".

320 Part 4: Full application with data

 In the linguistic options, you have the ability to choose the text direction for
Notes
the language ("Various" tab, "Text direction" option). This allows you to create
interfaces with a language written from right to left.

Validate. A message proposes to synchronize the different project elements. Answer "Yes". All
the project elements opened in the editor (windows, reports, ...) are closed and the additional
languages are added to these elements.
Note: The captions that exist in the base language of the project are automatically copied into
the added languages.

Localizing the analysis

By default, an analysis is created in a language and it cannot be translated.
However, some information can be entered in several languages (notes in the documentation,
shared information...).
If your application is using Reports and Queries, the file names and the item names can also be
translated. This translation can be performed in the "Reports and Queries" tab (in the description
window of the files or items).
By default, the controls created from the analysis items have the item caption specified in the
analysis. If a caption was specified in the shared information of the item, this caption will be used
when creating the control.
When changing the language of the project linked to the analysis, this change is not automatically
applied to the analysis. Indeed, an analysis can be shared between several projects.

To support several languages in an analysis:

1. Display the data model editor: click among the quick access buttons of the WINDEV menu.
2. In the analysis description ("Analysis description" from the popup menu), select the
"International" tab.
3. The list of languages supported by the analysis is displayed. The French language not being
supported:
• Click the "Add" button.
• Select "French".
• Validate the window for adding languages.

4. Validate the description window of the analysis.

Part 4: Full application with data 321

 Note To take into account all the languages of the project linked to the current analysis,
you also have the ability to click the "Synchronize with the project" button.

To enter the shared information in several languages, let's take a simple example: the caption
of the control linked to the "Address" item of "Customer" file:
1. Select the Customer file.
2. Display the description of the items found in a data file ("Description of items" from the
popup menu of the file).
3. Select the "Address" item and display the parameters of the control linked to the selected
item (shared information). To do so, click the double arrow at the bottom of the screen .

4. In the "Caption" area, type the caption for the French language: "Adresse".
5. Validate.

The shared information of the analysis can be translated:

• when creating the analysis.
Note

• at any time via the editor.

• at any time via WDMSG and WDTRAD, tools used to check out, translate and
check in the different elements.

322 Part 4: Full application with data

To take into account the modifications performed in the analysis, you must generate the
analysis: on the "Analysis" pane, in the "Analysis" group, click "Generation".

Localizing the project elements

All the project elements can become multilingual elements: windows, reports, help system, ...
We are going to modify some elements of the WIN_Menu window to present the different methods
that can be used.
We are going to modify:
• the image of the bar used in the WIN_Menu window.
• the captions of the controls found in the WIN_Menu window.
• the menu options.
• the message displayed by the WLanguage code when closing the application.
Open the "WIN_Menu" window in the editor (double-click its name in the "Project explorer"
pane for example).
First of all, we must check whether the WIN_Menu window is associated with the different
languages defined in the project:
1. Display the window description ("Description" from the popup menu of the window).
2. Select the "Language" tab: the two languages selected in the project are displayed.

3. Validate the window.

Part 4: Full application with data 323

 Localizing an image

To change the image of the bar used in the WIN_Menu window according to the runtime
language:
1. Open the "WIN_Menu.WDW" window.
2. The image of the bar is found in the template associated with the window. Therefore, the
associated window template must be opened:
• Click the "WD FullApplication" control and display the popup menu.
• Select "Open the template".

• The window template appears, enclosed in an orange border.

3. Display the description window of the bar:
• Select the "WD FullApplication" control and display the popup menu.
• Select "Description".
4. In the "Image" area, click the button.

5. The window for managing the multilingual images is displayed. A different image can be
used for each language. This feature is very useful if you are using images containing text.

6. For our example, in the "French" area, select the "header-fr.png" file.
7. Validate. The "Multilingual value" caption appears in the "Image" area of the description
window.

324 Part 4: Full application with data

 8. Validate the description window of the control.
9. Save the window template ( or CTRL S).
10. Update the windows that are using the window template by clicking the icon in the
orange bar. Validate the update window.
11. Close the window template displayed in the editor.

Localizing the controls

A control can display various information to the user:
• a caption,
• a help message,
• an image, ...
This information must be translated. This information is accessible in the different tabs of the
description window of the control.
For our example, we are going to translate the first pane of the Tab control.
1. Double-click the Tab control to display its description window.
2. In the "General" tab of the description window, select the first tab "List of products".
3. In the "Description of static pane" section, you can:
• type the translation for the caption of the pane: "List of products".
• define a specific image for the tab pane according to the language (as already done before).
• define a tooltip for each language.
4. Close the description window of the control.

Localizing a programming message

All the messages found in your program can be translated into several languages. In our example,
selecting the "Exit" menu displays the message "Exit from the application". We are going to
translate this message.
To translate the message of the menu option:
1. Display the code of the menu option:
• Expand the menu in the editor.
• Select the "Exit" option.
• Display the popup menu (right mouse click) and select "Code".

2. To translate this type of message, position the cursor in the string "Exit from the application?"
and press [CTRL T]. You can also, on the "Code" pane, in the "Languages" group, expand
"Translate the strings" and select "Translate the messages".

Part 4: Full application with data 325

 3. The following window is displayed:

4. This window allows you to translate all the messages of your program into all project
languages.
5. In the "French" area, type "Quitter l'application?" and validate.
6. The icon as well as a number appears in the code editor.

These icons indicate that the multilingual message exists in 2 languages.

7. Close the code editor.

Localizing the menus

The menu options can be translated like the other controls via the description window of the
option, or from the window editor directly.
To translate the menu of the "WIN_Menu" window:
1. On the "Display" pane, in the "Options" group, expand "Language displayed" and select the
language that will be viewed in the editor (French in our case).
2. The menu options are displayed in the selected language. If no translation corresponds to
the selected language, the menu options are displayed in English.
3. Expand the "Menu" option.
4. Select "Send an email".
5. Press the [SPACE] key on the keyboard: the caption becomes editable.
6. Type the caption in French: "Envoyer un email" and validate.
7. Switch the displayed language back to English: on the "Display" pane, in the "Options" group,
expand "Displayed language" and select "English".

326 Part 4: Full application with data

The translation tools
Some elements of our application have been translated manually.
Several methods can be used to translate this information:
• a direct translation of messages performed in the different editors. This translation can be
performed via a translation tool, Google Translate (providing that you own a license), ...
• a translation performed via an external tool (WDMSG and WDTRAD).

Direct input of translations

The translations are entered in the interface of the product directly. For example, the caption of
the "New" button becomes "Nouveau" in French. All you have to do is open the description window
of the control and type the corresponding translation in the requested language.
If you want to use a translation software or a translation site, WINDEV can be configured to use
this software:
1. On the "Home" pane, in the "Environment" group, expand "Options" and select "General
options of WINDEV".
2. Display the "Translation" tab.

3. Specify:
• Whether the regional settings must be automatically enabled according to the language
used for the input. In this case, if the language requires a specific character set, this
character set will be automatically selected.
• The software or the site that must be used for the translation. You have the ability to use
WDDixio, translation dictionary supplied with WDMSG (see next page), a specific translation
software or site, or Google Translate (see the online help for more details).
• The supported languages.
4. When the translation parameters are defined, you have the ability to use the button
found in the different description windows of the project elements: this button allows you to
use the software defined for the translation.

Part 4: Full application with data 327

 Translation with WDMSG and WDTRAD
A tool named WDMSG (not supplied with WINDEV) can be used to:
• check out all the project messages (caption of controls, code message, title of windows, ...) in
order to translate them,
• check the translated messages back in.
The messages to translate are checked out:
• in a text format that can be configured to be used by most of the translation tools
• in HFSQL format.
WDMSG is also supplied with a tool for computer-assisted translation, WDTRAD. WDTRAD is used
to easily enter all the translations for the multilingual information of a project.
Contact PC SOFT Sales Department for more details about WDMSG and WDTRAD.

Other elements to translate: the framework messages

Various information and messages are found in the WINDEV framework. For example, the names
of the days and months used by the functions for date management come from the WINDEV
framework. To translate one or more libraries of this framework, you must use WDINT (not supplied
with WINDEV).
This program is used to get a file whose extension is WDM. To use this file in your application:
• you have the ability to use LoadError.
• you have the ability to include the file to the project description in the "Languages" tab. All you
have to do is select the requested language and select the "Various" tab.

Contact PC SOFT Sales Department for more details about WDINT.

328 Part 4: Full application with data

Programming the change of language
By default, the project is run in the runtime language defined for the project, in the "Languages"
tab of the project description ("Description" in the "Project" pane).
In an application, the language can be chosen via a menu option. Nation used in the process
associated with the menu option allows you to change the language of the application currently
run.

Adding a menu option

To add a menu option:

1. Open (if necessary) the "WIN_Menu" window in the editor (double-click its name in the project
explorer).
2. Click the "Menu" option of the window. The menu is expanded.
3. Select "Send an email".
4. Display the popup menu (right mouse click). Select "Add after". Type the caption
("Languages") and validate.
5. Select the "Languages" option that was juste created.
6. Display the popup menu (right mouse click) and select "Transform to expand a sub-menu".
7. Type the caption of the first sub-option: "English".
8. Press the [ENTER] key twice and type the caption of the second option ("French").
We are now going to type the WLanguage code required to change language.

Programming

To type the code for managing languages:

1. Select "Menu .. Languages .. French" in the editor.
2. Display the popup menu (right mouse click). Select "Code".
3. Type the following code:
Nation(nationFrench)

4. Select "Menu .. Languages .. English" in the editor.

5. Display the popup menu (right mouse click). Select "Code".
6. Type the following code:
Nation(nationEnglish)

Nation is used to change the runtime language of the project. The constants passed in parameter
allow you to specify the language to use.
The change of language performed by Nation is immediately effective.

Part 4: Full application with data 329

 Project test
Some application elements being translated, we are now going to check the change of language.
To run the application test:
1. Run the project test ( among the quick access buttons). The window is displayed in test
mode in English.
2. Select "Menu .. Languages .. French".
3. The elements that have been translated are displayed in French:

4. End the test and go back to the editor.

330 Part 4: Full application with data

 Lesson 4.17.  SCM

This lesson will teach you the following concepts...

• Overview
• The Source Code Manager
• Using the Source Code Manager

Estimated time: 30 min

Part 4: Full application with data 331

 Introduction
The development of a large IS system requires the participation of several developers. These
developers must work on a single WINDEV project while sharing the different resources (windows,
classes...).
WINDEV is supplied with a Source Code Manager named "SCM" used to share the source codes
of different projects between developers and to find out the full history of the modifications
performed (in the code, in the interface, ...).

SCM (Source Code Manager)

Principle of SCM
The Source Code Manager is used to store and share the projects and their elements.
The principle is as follows:
• A reference version of each one of your projects is found on a server. All these versions are
called "SCM database".
• Each developer has a local copy of the different projects on his computer.

LOCAL COPY
SCM server
Local Developer
project
Local network
LOCAL COPY

Reference Local Developer

project ADSL (Internet)
project
LOCAL COPY
Local Developer
project Disconnected

• Whenever a developer wants to modify a project element (window, report, query, ...), he
informs the SCM that he is becoming the temporary owner of this element. To do so, this
element will be checked out from the SCM database by the developer.
• This developer gets exclusive rights on this element: all the requested modifications can be
performed on this element.
• The other developers are still working on the copy of the reference version of this element
(found in the SCM database).
• When the modifications have been made by the developer, the checked-out element is
checked back into the SCM database.

332 Part 4: Full application with data

 • The other developers are automatically notified of this check-in operation. They can now
update their local copy.
SCM server Developer
1 CHECK OUT
Local network
AN element

Local
project

Reference 3 Check-in 2 MODIFICATION

project
Developer
SYNCHRONIZATION ADSL (Internet)
4
SY

Local
N

4 project
CH
RO
N
IZ

Developer
AT
IO

Disconnected
N

Local
project

The SCM supports teamwork and it allows you to find out the history of all the modifications.
The SCM can also be used to manage and control the elements shared between several projects.

Creating the SCM database

To share a project via the Source Code Manager, a SCM database must be created. This SCM
database must be created once only on a server.
This SCM database can be created:
• when installing WINDEV.
• when creating a project that is using the SCM.
• when importing a project into the SCM.
• whenever you want, from WINDEV directly or from the SCM administrator.
The SCM database can be installed in the following modes:
• HFSQL Classic,
• HFSQL Client/Server,
• Cloud. The Cloud mode allows you to access the source codes of projects from anywhere, at
any time. See the www.pcscloud.net site for more details

Part 4: Full application with data 333

 Our SCM database will be created when a project is imported into the SCM (next step).
We advise you to perform backups of the SCM database on a regular basis. To
do so, you must:
Notes

• connect as administrator to the management tool of SCM.

• on the "Management" pane, in the "Backups" group, click "Full backup of
database".

Including a project in the SCM

Adding the project into the SCM

To use an existing project with the Source Code Manager, all you have to do is include this project
in the SCM database.

If you did not perform the operations in the previous lessons, you can follow this
Answer

lesson by opening a corrected project: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "Full application (Answer)"

We are now going to include the "WD Full Application.WDP" project in the SCM database:
1. On the "SCM" pane, in the "Project" group, click "Add the project". The wizard for adding
projects into the SCM starts:

The SCM database was not created yet. We are going to create one.
Note: We are going to create a "local" SCM database (on the development computer). The
operating mode would be similar for a network SCM database.

334 Part 4: Full application with data

 2. Click the "Create a database" button.
3. The screen used to create the database is displayed.

The SCM database can be in HFSQL Classic format (local or network) or in HFSQL Client/
Server format. We are going to create a SCM database in HFSQL Classic format.
Notes

If the SCM database is in HFSQL Client/Server format, then this SCM database
can be used remotely.

4. Select "Creating a database in network share mode" and specify the directory of this SCM
database ("C:\My Projects\Local SCM database" for example).
5. Validate the creation of the SCM database ("Create the database" button).
6. The SCM database is now created. We are going to include our project in this SCM
database.
7. Go to the next step.

Part 4: Full application with data 335

 8. The wizard proposes to place the project in the "WINDEV projects" sub-directory of the SCM
database.

We are going to accept this location. Go to the next step.

9. The wizard asks you to select the project elements that must be added into the SCM
database.

We want to add all the project elements. Go to the next step.

10. The wizard asks you to select the project dependencies that must be added into the
SCM database. These dependencies correspond to all the external elements required by the
project (images, style sheets, ...).
We want to add all the project dependencies. Go to the next step.

336 Part 4: Full application with data

 11. Validate the inclusion of the project in the SCM. The project and all its elements have
been added into our SCM database.
A help window about the toolbar for using the SCM is displayed. Read and validate this
window.
Sharing the project elements
When the projects that share the same resources (same analysis, same
Notes

windows, ...) are included in the SCM, the relevant elements can be shared
between the different projects. Therefore, the same element is checked in once
only into the SCM and the modifications are automatically applied to the other
projects.

Opening a project from the SCM

In our example, the project is included in the SCM and it can be used directly.

In a real case, in order for other developers to work on a project found in the Source Code
Manager, they must retrieve a copy of this project locally.
To do so, the following operations must be performed:
1. Open your project from the Source Code Manager: on the "Home" pane, in the "General"
group, expand "Open" and select "Open a project from SCM".
2. Specify the location parameters of the SCM database and validate (this step is required
only if the current project in the editor does not belong to the SCM):

Part 4: Full application with data 337

 3. In the screen that is displayed, specify (if necessary) the connection and the local directory:

Note: If the project was already opened from the SCM, the SCM proposes to open the project as
usual or to overwrite the content (to retrieve the entire project).
This operation must be performed once only by each developer who is using the project.
The developer who added the project into the Source Code Manager (you in this case!) has no
operation to perform.

The method for opening a project managed by the SCM is identical to the method
Notes

for opening a project not managed by the SCM: all you have to do is open the
project (".WDP" file) corresponding to the local copy.

Configuring the SCM

Before you start working on the elements of the project found in the SCM, you must configure the
mode for checking out the project elements.
When working on the elements of a project found in the SCM, the element must be checked out
from the SCM database before it can be modified, then it must be checked back in once the
modifications have been performed. Therefore, the modified element becomes available to all the
SCM users.
WINDEV proposes two modes for checking out the project elements:
• the standard mode: if you display a SCM element that is not checked out, a dialog box indicates
that this element must be checked out before it can be modified. The element can be checked
out immediately (check-out button found in the panel).
• the automatic mode: if you try to modify a SCM element that is not checked out, the SCM automatically
proposes to check out this element. Once the check-out is validated, the element can be modified.
Note: this mode is not recommended when the SCM is used with a slow Internet connection.

338 Part 4: Full application with data

The automatic check-out will be used in this tutorial.
To make sure that the automatic check-out is enabled, on the "Home" pane, in the
"Environment" group, expand "Options" and select "General options of WINDEV". In the
"General" tab, check (if necessary) "Check out elements during the first modification".

Handling the project via the SCM

We are now going to work with the SCM in real conditions by performing the following operations:
• Modify a project parameter.
• Modify a project window.

Modifying a project parameter

We are going to modify the project by asking to display the skin template on the system
windows:
1. Display the project description: on the "Project" pane, in the "Project" group, click "Description".
2. Click the "Style" tab.
3. Check "Apply the theme of skin template to the system windows".
4. Validate the description window of the project.
Several SCM windows appear:
1. First of all, the window for automatic project check-out is displayed. Indeed, we want to modify
a project characteristic so the project must be checked out.

2. The option "Automatically check the project back in at the end of operation" is used to
automatically check the project back in at the end of its modification. Keep this option.
3. Validate this window.
4. WINDEV proposes to recompile the project. Accept the full project recompilation.
5. The description window of the project is closed and the project is automatically checked
back into the SCM database.

Part 4: Full application with data 339

 Modifying a project window
We are now going to modify the "WIN_Product_form" window: the click on the image must allow to
modify the image (like the "Modify" button).

The method for modifying a checked-out element (GUI, code, ...) is the same as the method for
modifying an element in a project not managed by SCM.
However, the modifications performed on a checked-out element are not visible to the other
developers.
If another developer runs the checked-out element, the element that is currently found in the SCM
database will be used.
This allows you to make an application evolve by keeping a steady version in the SCM database.

To modify the "WIN_Product_form" window:

1. Select the "WIN_Product_form" window in the project explorer and double-click the element
to open it in the window editor.

2. The automatic check-out is enabled during the first modification: all you have to do is move
a control to check the element out. You also have the ability to click the "Check out" icon found
in the ribbon ( ).

340 Part 4: Full application with data

 3. The check-out window is displayed:

4. The SCM proposes three check-out modes:

• Exclusive (recommended mode): no one else will be able to check out this element until it is
checked back in. The element can be checked out for test only.
• For test: the element can be modified but the modifications will not be checked back in.
• Multiple: the element can be checked out by the other users. In this case, the differences
between the different versions of the element can be viewed when the element is checked
back in. This mode is reserved to specific cases and to experienced developers.
5. The window will be checked out in exclusive mode. Keep the "Exclusive" option checked.
6. Enter a comment ("Image modification" for example). This comment will be useful for the
other developers.
7. Validate the check-out. The window is checked out.
8. Display the description window of the Image control ("Description" from the popup menu).
9. In the "GUI" tab, modify the cursor used: select the "System hand" cursor.
10. Validate the description window of the control.
11. Display the code of the Image control: select the Image control and press [F2] for example.
12. Enter the following code in the "Click on..." process:

// Runs the click code of the button that modifies the image
ExecuteProcess(BTN_Modify, trtClick)

13. Close the code window.

14. Save your window (CTRL + S).

Part 4: Full application with data 341

 Test your modifications.
1. Run the project test ( among the quick access buttons).
2. Select a product and click "Modify".
3. In the form that is displayed, click the image of the product: the file picker is opened to
modify the image of the product. This is the expected operating mode.
4. Close the test window.

Checking the checked-out element back in

Now that the modifications are completed, we are going to check the window back into the SCM
database. Then, your modifications will be made accessible to the other developers.
On the "SCM" pane, in the "Current element" group, click the "Check in" button. The following
screen is displayed:

This screen is used to:

• find out the modifications performed by comparing the element found in the SCM database
with the checked-out element ("My Modif" button).

Merging code
Notes

You have the ability to compare an element to one of its earlier versions.
This allows you to compare the code in order to retrieve a code section
that was "lost" or accidentally deleted by another developer.

• access the history of the element found in the SCM database ("Properties" button).
• enter a comment about the modifications performed. By default, WINDEV proposes the
comment typed during the check-out.
• send a message to the other developers.
• check in the modifications made to the element while keeping the element checked out
("Keep the element checked out").

342 Part 4: Full application with data

 If you are using the Control Centers, the current task can be ended when the
Notes element is checked back into the Source Code Manager. This feature is useful to
follow the monitoring of tasks, the corrections of bugs, ...

5. Validate the check-in.

6. The window is displayed in the editor.

Synchronizing the project

Several options can be used to configure a project handled by SCM. These options are grouped
in the "SCM" tab of the project description (to display it, click "Description" on the "Project" pane).

These options are as follows:

• Propose to get the latest version of the elements when the project is opened.
When opening a project found in the SCM database, this option proposes to retrieve the
latest version of the project elements.
• Propose to check in the elements when the project is closed.
When closing the project, this option is used to display the list of elements that are
currently checked out in order for some of them (or all of them) to be checked back in.
By default, the checked-out elements are not checked back in when closing the project.
• Check out/Check in the project automatically.
This option is used to automatically check out or check in the project when handling an
element.
This option is selected by default.

Part 4: Full application with data 343

 Off-line mode (or mobile mode)
The SCM allows you to work in off-line mode (or mobile mode).
This mode allows a developer who is using a laptop computer to continue to work on a project
found in the SCM database while being disconnected from the SCM database.
The principle is straightforward:
• before the disconnection, on the "SCM" pane, in the "Other actions" group, expand "Remote
work" and select "Disconnect for a mobile use".
• during the reconnection, on the "SCM" pane, in the "Other actions" group, expand "Remote
work" and select "Reconnect and synchronize". Then, all you have to do is check the modified
elements back in.
In mobile mode, two solutions are available for checking out elements:
• No element is checked out from the SCM. The other developers will be able to work on the
same elements as you while you are working in off-line mode. When you reconnect to the
SCM, the modifications made by yourself to the element will have to be merged with the
modifications made by the other developers.
• The elements that you want to modify are checked out in exclusive mode. No one else can
use the element while you are working in off-line mode.

SCM administrator
The SCM administrator is used to directly handle the different projects included in the source code
manager.
It is used to:
• manage the SCM databases (creation, connection to a SCM database).
• manage the files and directories found in a project of the SCM database (add, delete,
rename, ... files and directories).
• manage the different files of the SCM database (check-in, check-out, share...).
• start some tools (options, maintenance, ...).
• show the history of an element.
• show the status of elements.
• perform backups.
• grant rights to the different SCM users.
• list the projects in which you are taking part in order to dissociate from them (if necessary).

344 Part 4: Full application with data

Start the SCM administrator: on the "SCM" pane, in the "Database" group, click the "Manage"
button. All the project elements are listed in the administrator.

See the online help of WINDEV (keyword: "SCM") for more details.

Disconnecting from the SCM

In the rest of this tutorial, we will be using the "WD Full Application" application. To simplify the
operations, we advise you to disconnect from the SCM:
1. Display the description window of the project: On the "Project" pane, in the "Project" group,
click "Description".
2. In the "SCM" tab, select "No developer groupware and no SCM".
3. Validate the description window of the project.

Conclusion
We have presented the main steps for developing an application.
WINDEV proposes several tools to optimize your applications. See “Project audits”, page 375 for
more details.

Part 4: Full application with data 345

 346 Part 4: Full application with data
 PART 5

Managing
a HFSQL Client/
Server database
 348 Part 5: Managing a HFSQL Client/Server database
 Lesson 5.1.  Introduction

This lesson will teach you the following concepts...

• Principle of Client/Server
• Why switch an application to HFSQL Client/Server?

Estimated time: 5 min

Part 5: Managing a HFSQL Client/Server database 349

 Overview
WINDEV allows you to create applications accessing HFSQL Client/Server databases.
A database in Client/Server mode allows you to host the databases on a server.
This operating mode:
• increases the security of data,
• allows you to easily manage the multi-user mode,
• simplifies the maintenance, ...

Client computer 1

WinDev application

Client computer 2 Windows or Linux

HFSQL server

Manta server

WinDev application

HFSQL
Client computer n Client/Server
databases

WinDev application

WINDEV is used to:

• create an entire application using a HFSQL Client/Server database.
• modify an application that is using a HFSQL Classic database so that it can use a HFSQL Client/
Server database.

350 Part 5: Managing a HFSQL Client/Server database

Why switch an application to HFSQL Client/Server mode?
The main benefits of an application in HFSQL Client/Server mode compared to an application in
HFSQL Classic mode are as follows:
• The use of HFSQL Client/Server is more secured (use of a login and password and definition of
rights granted to the users).
• No management of directories: all the database files are grouped at the same location.
• The end users do not see the data files in the explorer and they cannot access them directly.
• The databases in Client/Server mode can be used via an Internet connection.
• Management of native multi-user mode: the performances are optimized in multi-user mode.

Part 5: Managing a HFSQL Client/Server database 351

 Lesson 5.2.  Implementation of a
Client/Server database

This lesson will teach you the following concepts...

• Installing a local HFSQL server

• Creating an application that is using a HFSQL Client/Server database
• Adapting an application to manage a HFSQL Client/Server database
• Features available in Client/Server mode

Estimated time: 10 min

352 Part 5: Managing a HFSQL Client/Server database

Overview
In this lesson, we are going to perform all the operations required to develop and to deploy an
application that is using a HFSQL Client/Server database.

Installing a local HFSQL server

The first operation to perform consists in installing a HFSQL server.
This server can be installed locally on the development computer (that's what we are going to do).
In deployment, this server can be installed on a specific computer.
The setup program of the HFSQL server is available on the WINDEV DVD. If you do not own this
DVD, the setup of the HFSQL server is also available from the PC SOFT site (www.pcsoft.fr).
To install the HFSQL server locally:
1. Start the setup program of WINDEV.
2. Choose "HFSQL Client/Server Setup".
3. Then, select "Install a HFSQL Client/Server server".
4. Accept the license agreement.
5. Choose the platform ("For Windows on this computer").
6. If HFSQL servers are already installed on the current computer, select "Install a new server".
7. Select the setup directory and specify the server name and port. The port 4900 will be used
by default.
Notes

Don't forget to open this port on the firewall in order to connect to the HFSQL
server from another computer.

8. The wizard asks for the recipients of the notifications of HFSQL server. This information
is not required in this tutorial. Go to the next wizard step and confirm that the setting will be
performed later.
9. Install the HFSQL Control Center if this one is not already found or accessible from your
computer.
Caution!

The HFSQL Control Center is required to manage the HFSQL Client/Server

database.

10. Specify whether you want to take part (or not) in the product improvement by allowing us to
collect information regarding the use of product. This optional and anonymous collect allows
PC SOFT to improve the product features.
11. The setup is performed. By default, to connect to the server in administrator mode, use
the "admin" user without password.
Notes

For security reasons, don't forget to change the administrator password.

Part 5: Managing a HFSQL Client/Server database 353

 Creating an application that is using a HFSQL Client/Server
database
Creating a WINDEV application that is using a HFSQL Client/Server database is child's play. You
must:
1. Create the project by asking to create a new database.
2. Create the analysis by specifying that the databases used by the project will be "HFSQL
Client/Server" databases.
3. Specify the characteristics of the connection to the HFSQL Client/Server server that will be
used.
4. When creating a file in the analysis, indicate that this file is in Client/Server mode and
specify the connection used.
Notes

You can also describe the connection to the HFSQL server by programming. See
the online help ("HDescribeConnection") for more details.

Adapting an application to use a HFSQL Client/Server

database

Overview
Switching a database from the HFSQL Classic mode to the Client/Server mode is the most
common operation.
WINDEV proposes several methods to perform this switch:
• perform this adaptation in the data model editor.
• perform this adaptation from the HFSQL Control Center.
To better understand the different steps, we are going to switch the application that was created
in Part 3 to Client/Server mode by using the first method, the data model editor.

Adapting the example

If you did not perform the operations in the previous lessons, you can follow this
Answer

lesson by opening a corrected project: on the "Home" pane, in the "Online help"
group, expand "Tutorial" and select "Full application (Answer)".

354 Part 5: Managing a HFSQL Client/Server database

To adapt the project:
1. Open the "WD Full Application" project if necessary.
2. In the project explorer, select (if necessary) the project configuration "Windows 32-bit
executable".
3. Load the analysis of your project in the data model editor: click among the quick access
buttons. The data model editor is displayed.
4. On the "Analysis" pane, in the "Connection" group, click "New connection". A wizard is
opened, allowing you to create a connection.
5. Select the type of connection to create: "HFSQL Client/Server".

6. Go to the next step.

7. In the following steps, specify:

• the server name (name of your computer for example) and the port number. Go to the next
step.
• the user name and password (leave this information empty to use the administrator). Go to
the next step.
• the database name ("WD Full Application" in our example). Go to the next step.
8. Type the connection name (keep the proposed name).

Part 5: Managing a HFSQL Client/Server database 355

 9. Go to the next step and validate. The connection to the database is automatically created.
The wizard proposes to associate the different data files found in the analysis with the
connection that was just created.

10. Click "Yes".
11. In the next step, select all the proposed files:

Go to the next step.

12. Then, the wizard proposes to copy the data files onto the server. Validate ("Copy now").

13. Select the data files that will be copied onto the server: in our case, all the data files found
in the EXE directory.

356 Part 5: Managing a HFSQL Client/Server database

 14. Go to the next step and validate.
15. The data files of the analysis are automatically changed to HFSQL Client/Server data files
and associated with the selected connection.

16. Generate the analysis: on the "Analysis" pane, in the "Analysis" group, click "Generation".
An automatic modification of data files is automatically performed. You have the ability to
cancel the automatic modification of data files if all the data files are updated.

Part 5: Managing a HFSQL Client/Server database 357

 Switching to Client/Server mode: tips
• Check the code of your project: in HFSQL Client/Server, HSubstDir, ... are
useless
• According to the parameters specified when creating the connection, the
Notes

connection defined in the analysis can be modified by HOpenConnection and

HChangeConnection.
• HOpenConnection can be used to go back to the HFSQL Classic mode: all you
have to do is specify the path of the directory containing the HFSQL Classic
data files.

17. The development project was successfully adapted. You may also have to adapt the
deployed application (if the deployed application is using HFSQL Classic files for example).
This operation is configured when creating the setup program of the application.

Features available in HFSQL Client/Server mode

HFSQL Client/Server proposes several features:
• Transactions,
• Logs,
• Stored procedures,
• Triggers,
• Hot automatic data modification,
• Hot reindexing,
• Scheduled backups,
• Incremential backups,
• Universal replication.
These features will not be described here (some of them have been presented in this tutorial in
HFSQL Classic mode). See the online help for more details.

358 Part 5: Managing a HFSQL Client/Server database

 Lesson 5.3.  Managing a Client/Server
database

This lesson will teach you the following concepts...

• The HFSQL Control Center

• Creating a user in the HFSQL Control Center
• Saving the database

Estimated time: 20 min

Part 5: Managing a HFSQL Client/Server database 359

 Overview
Now that we know how to create and/or adapt an application so that it operates in HFSQL Client/
Server, let's see how to manage the associated database.
Indeed, a Client/Server database requires:
• a specific configuration of computers (setup of a HFSQL server, ...).
• a management performed via the HFSQL Control Center.

Configuring the computers

To use a HFSQL Client/Server database, a HFSQL server must be installed on the server. Several
HFSQL servers that use different ports can be installed on the same computer. One or more
databases can be installed on each server.
For example, a test HFSQL server that includes a test database and a production HFSQL server
that is using a different port can be installed on the same computer.

The HFSQL Control Center

The HFSQL Control Center is used to perform all the management operations on the HFSQL Client/
Server servers and databases.
We are going to present the most important features.
First, we are going to start the HFSQL Control Center from the WINDEV project.
To start the HFSQL Control Center and to access data:
1. In the WINDEV menu, on the "Tools" pane, in the "Database" group, click "HFSQL". The
HFSQL Control Center is displayed.
2. The home window of the HFSQL Control Center is displayed. The analysis of the current
project is automatically selected.

3. Validate the screen. The HFSQL Control Center is displayed. This start mode allows you to
see the different files linked to the analysis of the current project.

360 Part 5: Managing a HFSQL Client/Server database

 4. Click the vertical tab named "HFSQL C/S" if necessary. The list of data files in HFSQL
Client/Server format is displayed.

The Control Center lists the Client/Server data files found in the analysis linked to the current
project. No connection is established: the files are grayed.
5. To see the data found in the files, double-click one of the data files in the list on the left
("Orders" for example). If the HFSQL Control Center does not recognize all the connection
parameters, a connection window is used to perform the effective connection to the HFSQL
Client/Server server used. If this window is displayed, specify the password and validate.
6. The information about the selected data file that is using this connection is displayed in a
new tab:

• The "Description" tab gives information about the data files (file items, ...).
• The "Content" tab displays the records found in the data files.

Part 5: Managing a HFSQL Client/Server database 361

 The entire HFSQL Client/Server database can be managed from the HFSQL Control Center.

Creating a user account in the HFSQL Control Center

A single user account is created when installing a HFSQL server and when creating a database:
the administrator account ("Admin" login without password).
Using a user account allows you to secure the access to data. Indeed, all the application users are
not administrators. Specific rights can be granted to each user (or group of users).

The user rights specified in the HFSQL Control Center are granted for the
Caution!

database (and not for the application).

Do not confuse the management of rights for the Client/Server databases with
the user groupware.

Some users may not have the rights to write into some data files for example.
To run a simple test, we are going to create a user and allow this user to see the records found in
Customer file.
To directly connect to the database found on the server:
1. Expand the menu found at the top left of the HFSQL Control Center and select
"Connect to a HFSQL server".
2. The home window is displayed in the HFSQL Control Center.

3. The option "Connect to a HFSQL server" is selected by default. Specify the characteristics of
the server that was installed in the previous lesson and validate.
4. The characteristics of the HFSQL server are displayed:
• in the panel on the left, the name of the HFSQL server as well as the list of databases found
on this server appear.
• in the right section of the screen, a new tab is displayed, allowing you to see the
characteristics of the HFSQL server.

362 Part 5: Managing a HFSQL Client/Server database

 5. Select the "Users" tab. This tab is used to manage the users of the server.
6. Only the "Admin" user exists at this time.

7. To create a new user, in the ribbon, in the "Users" group, click the "New" button. The screen
used to define the user characteristics is displayed.

Part 5: Managing a HFSQL Client/Server database 363

 8. Enter the following information for example:

(use "Test" as password for example).

Several characteristics can be noticed:

• Super User: The users defined as "Super user" are allowed to perform all the
actions on the server, on the databases and on all the files.
Notes

• Account enabled: If this option is not checked, the user exists but he is not
enabled (users on holiday for example).
• Password expiration: A password can be valid for a given number of days only.
(configurable).

9. Validate the user creation. By default, no rights are granted to this user.
We are now going to grant rights to the user: the "Test" user can connect to the database and he
can read the Customer file.

364 Part 5: Managing a HFSQL Client/Server database

To grant the rights to connect to the database:
1. In the HFSQL Control Center, double-click the "WD Full Application" database.
2. On the "WD Full Application" pane, in the "Rights" group, click "Managing rights".
3. Select the "Test" user in the list of users.
4. In the list of rights, for the action named "Rights to connect to the server (encrypted and
non-encrypted connection)", click the "Defined rights" column and select the green checkmark.

5. Click the “Apply” button found at the bottom of the window (blue arrow). The rights become
effective.
6. Close the window for managing rights.

Part 5: Managing a HFSQL Client/Server database 365

 To grant the rights to read the Customer file:
1. In the HFSQL Control Center, expand the "WD Full Application" database and double-click the
Customer file (on the left of the screen).
2. On the "Customer" pane, in the "Rights" group, click "Managing rights".
3. Select the "Test" user in the list of users.
4. In the list of rights, for the action named "Rights to read the file records", click the "Defined
rights" column and select the green checkmark.

5. Click the "Apply" button found at the bottom of the window (blue arrow). The rights become
effective.
6. Close the window for managing rights.

Similarly, rights can be defined:

• on the HFSQL server
• on the database
• on the database files.
In our example, the "Test" user will have the ability to browse the records found in Customer file.
If this user tries to perform another action, a message will be displayed: "The Test user has no
sufficient rights to XXXX" (where XXXX corresponds to the action performed).
Once the account is created, it can be used when the application connects to the server (when
HOpenConnection is used).
Notes

The users and their rights can also be managed by programming with the
WLanguage functions. See the online help for more details.

366 Part 5: Managing a HFSQL Client/Server database

Saving the database
To save the database:
1. Position on the tab corresponding to the "WD Full Application" database.
2. Select the vertical tab named "Backups".
3. In the menu, in the "Backups" group, expand "New backup" and select "New hot backup".
Note: This option is accessible in the "Backups" group:
• on the tab corresponding to the HFSQL server,
• on the tab corresponding to the database.
4. The wizard is launched.

Note: The wizard can also be used to save a selection of files.

Conclusion
The HFSQL Control Center is a tool for managing databases, allowing you to:
• stop or restart a server if a problem occurs,
• manage the users and their rights,
• reindex the data files if necessary,
• perform backups of the database.
The HFSQL Control Center is a redistributable tool that can be installed on the computers of the
users who are working with HFSQL Client/Server databases. The HFSQL Control Center must be
used by the administrator of the database.

Part 5: Managing a HFSQL Client/Server database 367

 Lesson 5.4.  Setup on end-user
computers

This lesson will teach you the following concepts...

• How to install a Client/Server application on the end-user computers?

Estimated time: 5 min

368 Part 5: Managing a HFSQL Client/Server database

Overview
Installing a Client/Server application requires several specific options. These options are taken
into account by the wizard for setup creation of WINDEV.
We are going to create the setup procedure of our "WD Full Application" application.

Starting the wizard for setup creation

To start the setup procedure of a HFSQL Client/Server application:
1. On the "Project" pane, in the "Generation" group, click "Setup procedure".
2. Create the executable and validate the creation of the help.
3. Go to the step named "Parameters of databases". In this step, you can:
• Include the setup of a HFSQL server,
• Configure the HFSQL Client/Server connections,
• Deploy the HFSQL Client/Server files.

If these options are checked, the next steps are used to configure the elements that will be
taken into account for the setup on end-user computers.
See the online help for more details.

Part 5: Managing a HFSQL Client/Server database 369

 370 Part 5: Managing a HFSQL Client/Server database
 PART 6

Optimizing and
debugging
a project
 372 Part 6: Optimizing and debugging a project
 Lesson 6.1.  Overview

This lesson will teach you the following concepts...

• Why optimize an application

• Example project

Estimated time: 5 min

Part 6: Optimizing and debugging a project 373

 Overview
Your application is created. It operates properly, several automatic tests have been created to
avoid the regressions. You want to deploy it on the end-user computers.
Do you know that several WINDEV tools can be used to optimize your application? WINDEV
proposes several tools and features allowing you to optimize your application and to avoid
predictable bugs.
This part presents these tools and their use.

A project to optimize was prepared, allowing you to handle these features!

Opening the project

Start WINDEV 22 (if not already done). Close (if necessary) the current project in order to
display the home window.
Open the "WD Optimization" project.
To do so, in the home window, click "Tutorial" and select "Optimize a project".
Tip: if the home window is not displayed, on the "Home" pane, in the "Online help" group,
expand "Tutorial" and select "Optimize a project".

374 Part 6: Optimizing and debugging a project

 Lesson 6.2.  Project audits

This lesson will teach you the following concepts...

• What is an audit and what is its purpose?

• Starting and analyzing the static audit
• Starting and analyzing the dynamic audit

Estimated time: 15 min

Part 6: Optimizing and debugging a project 375

 What is an audit?
The audits provide a set of features used to automatically improve the quality and the
performances of a project and to follow the conditions in which it is implemented.

Two types of audits are available:

• The static audit. The static audit performs a detailed analysis of a project and elements. This
audit is performed from the project editor.
• The dynamic audit. The dynamic audit analyzes the behavior of a project during its execution.
This audit can be performed in test mode or in the production environment.

We are going to check these audits on the "WD Optimization" project.

Static audit
The static audit is a feature of the environment used to study the source codes of a project in
order to detect different problems and to propose improvements.
To start the static audit on the "WD Optimization" project:
1. On the "Project" pane, in the "Audit and performances" group, expand "Edition audit" and
select "Trigger the edition audit".

The static audit of the project can also be started from the project dashboard,
via the "Static audit and Compilation" widget.
You must:
• enable the Widget if necessary (click the link "Click here to re-enable").
• click the arrow.
Notes

376 Part 6: Optimizing and debugging a project

 2. The wizard starts. We are going to define the target of the static audit.

3. Select "Run the static audit on the entire project".

4. Validate the wizard.
5. The audit report is displayed:

The static audit includes:

• The static audit of the project.
• The audit of the content of the application library.
• The audit of the setup content.
Let's study the topics presented by this report.

Part 6: Optimizing and debugging a project 377

 Procedure not run
In our project, the audit indicates that a procedure is never run.
In huge projects, you may want to create one or more procedures to perform a process then,
further to a code reorganization, the procedure is no longer used but it remains in the project.
The presence of unused procedures unnecessarily consumes the resources distributed to the end
users.
To fix this problem:
1. Click the [...] button to get more details. The window used to list the dead code is displayed.

2. The "ObsoleteProcedure" procedure is never called. This window is used to:

• specify that the procedure is still used ("Mark as used" button). In this case, the procedure
will not be taken into account anymore during the audit.
• delete the procedure if it is actually unused ("Delete" button).
• see the procedure ("View" button).
• find the use cases in the strings for example ("Search" button).
3. In our case, this procedure is actually unused, click "Delete".
4. A window is displayed, asking you to confirm the deletion. Click the "Delete" button to
confirm the deletion.
5. Close the window of dead code (click the cross in the top right corner).
In the window of static audit, click the "Refresh" button to update the audit report.

378 Part 6: Optimizing and debugging a project

Orphan element
The audit indicates that our project contains an orphan element.
As for the procedures run, you may create windows or reports in order to run a quick test, save
them and forget everything about them. The presence of orphan elements in the executable
unnecessarily consumes the resources distributed to the end users.
To fix this problem:
1. Click the [...] button to get more details. The window used to list the orphan elements is
displayed.

2. The "WIN_UnusedWindow" window is never called. The window that lists the orphan
elements is used to:
• specify that the element is still used ("Mark as used" button). In this case, the window will
not be taken into account anymore during the audit. This option can be interesting when
using a test window specific to the development for example.
• delete the element if it is actually unused ("Delete" button).
• see the element ("View" button).
• find the use cases in the strings for example ("Search" button).
3. In our case, this "WIN_UnusedWindow" window is actually unused, click "Delete".
4. Close the window of orphan elements (click the cross in the top right corner).
In the window of static audit, click the "Refresh" button to update the audit report.

Part 6: Optimizing and debugging a project 379

 Query to optimize
The audit indicates that our project contains a query to optimize.
This optimization is used to improve the execution speed of the query. The optimization of a query
is based on the following principle: a wizard defines the composite keys that must be modified
and/or added in the analysis associated with the project.
To optimize the query:
1. Click the [...] button to get more details. The window used to list the modifications to perform
is displayed.

2. The wizard proposes to modify an analysis item by changing it into a key with duplicates.
3. We are going to apply this change: click the "Apply these modifications to the analysis"
button.
4. A window is displayed, asking you to confirm the modification of the analysis. Validate this
window.
5. The data model editor is opened and the modification is performed. A message indicates
that the analysis must be generated. Click "Yes" to confirm the generation of the analysis.
6. The application is using data so an automatic modification of data files is required. Validate
the different steps of the wizard for data modification (by keeping the default options).
7. The window of the static audit is automatically refreshed.

380 Part 6: Optimizing and debugging a project

Cleaning the project
Our project contains several unused files. You have the ability to clean the project in order to keep
the necessary elements only. The executable and the client setup is not weighted with images,
external files, ... not used
To fix this problem:
1. Click the [...] button to get more details.
2. The wizard for cleaning a project starts. This wizard indicates the unused files that can be
deleted.
3. Go to the next step.
4. Select the type of cleaning to perform. You can:
• create a zip file with the useless files.
• move the useless files into a specific directory.
5. Validate the option proposed by default and go to the next step.
6. End the wizard.
Our project was optimized according to the tips given by the static audit.
The static audit is used to get an overall status on the source code of your project. Our advice: run
it on a regular basis!

Let's see what happens at run time by starting the dynamic audit.

Dynamic audit
The dynamic audit is used to analyze the execution of the application. The audit is used to detect
problems such as:
• Excessive memory consumption,
• Slowness of algorithms used,
• Errors "hidden" at run time,
• ...
A dynamic audit can be performed in a test environment or on a live application.
The "WD Optimization" project contains a specific window triggering errors that can be detected by
the dynamic audit.
The dynamic audit and the project test will be started at the same time.
To start the dynamic audit on the "WD Optimization" project:
1. On the "Project" pane, in the "Test mode" group, expand "Test mode" and select "Debug the
project while the audit is enabled". The project test is run.

Part 6: Optimizing and debugging a project 381

 The dynamic audit of the project can also be started from the project dashboard,
via the "Dynamic audit" widget. You must:
• enable the Widget if necessary (click the link "Click here to re-enable").
• expand the arrow and select "Detailed Go of project".
Notes

Note: The dynamic audit is automatically run whenever the application is started
by a project GO. A status report is automatically displayed in the dashboard:

2. Click the "Test window of dynamic audit" button.

3. Click the different buttons found in the window. At the end of each process, a toast message
is displayed to specify that the process is over. For the "Assertion and Exception" option, an
assertion is displayed: click "Continue" in order for the message to appear in toast format.
4. Stop the application test.
5. The report window of the dynamic audit is displayed.

382 Part 6: Optimizing and debugging a project

Let's study this window:
• The top section of this window is used to choose the display mode of data. You can:
• choose a chronological display (respecting the order in which the events occurred) or an
overall display, used to group the different types of problems. In this case, the chronological
border allows you to see the position and importance of problems.
• choose the type of problem to display (error, assertion, ...). This allows you for example to
concentrate on the major errors, ...
• The bottom section of this window displays the different events that occurred and that may
cause problems in the application.
In this example, the dynamic audit detects several problems:
• A too long static that is assigned by programming,
• A SWITCH loop for which no CASE is run,
• An assertion is triggered instead of an exception,
• The opening of a file that does not exist,
• The assignment of an image file that does not exist to an Image control.
For each problem, a "..." button is used to access the details of the event. If the event is
linked to a specific code line, the button is used to directly open the code editor at the
corresponding location in order to fix the problem.
Close the window of dynamic audit.

Part 6: Optimizing and debugging a project 383

 The dynamic audit of a project can also be performed when an application is
deployed on the user computers.
You can:
• modify the application and use dbgEnableAudit to start the audit.
Notes

• use a text file in the application directory. This solution allows you not to modify
the executable. All you have to do is create, in the directory of the executable, a
file named like the executable and whose extension is ".WX".
The audit generates a ".wdaudit" file, this file must be loaded in the development
environment in order to analyze the result.
See the online help (keyword: "Dynamic audit") for more details.

384 Part 6: Optimizing and debugging a project

 Lesson 6.3.  Performance profiler

This lesson will teach you the following concepts...

• Overview
• Starting the performance profiler
• Analyzing the result

Estimated time: 15 min

Part 6: Optimizing and debugging a project 385

 Overview
The performance profiler (also called Profiler) is a tool used to check and optimize the execution
time of the processes found in your application.

Its principle is straightforward:

• You run the test of your application.
• During this test, the performance profiler keeps track of all the actions performed and saves the
execution times of each one of the processes run.
At the end of test, the performance profiler displays:
• the 10 most time consuming operations,
• the duration and the number of calls for all the processes run.
The "WD Optimization" project contains a specific window used to see the interesting results with
the performance profiler.

Starting the performance profiler

The performance profiler can be started:
• from the WINDEV editor:
In this case, the project is automatically run in test mode. You can use your application and
start the processes of your choice.
To go back to the WINDEV editor, all you have to do is exit from your application.
The performance profiler displays the analysis result. This result is saved in a WPF file.
• from one of your processes in WLanguage, via the following functions:
ProfilerStart Starts "collecting data" for the performance profiler.

ProfilerEnd Stops "collecting data" for the performance profiler.

In this case, only the code found between ProfilerStart and ProfilerEnd is analyzed. The result is
saved in a WPF file.

386 Part 6: Optimizing and debugging a project

The first method will be used in our example. To start the performance profiler on the "WD
Optimization" project:
1. On the "Project" pane, in the "Audit and performances" group, expand "Analyze the
performances" and select "Analyze the performances".

The performance profiler can also be started from the project dashboard, via the
"Performances" widget. You must:
• enable the Widget if necessary (click the link "Click here to re-enable").
• expand the button with arrow and select "Analyze the performances".
Notes

2. The project test is run.

3. Click the "Test window of performance profiler" button.
4. Click the "Process to analyze" button.
5. Validate the information window and stop the project test. The report window of performance
profiler is displayed.

Analyzing the result

Let's take a look at the report window of performance profiler. The results are displayed in
several tabs:
• the "Summary" tab presents the ten longest processes.
• the "Mapping" tab presents a graphical view of main processes.
• the "Details" tab presents all the processes run during the application test (from the slowest
one to the fastest one).
• the "Calls" tab is used to see the details of the operations performed in a process.
Let's present these different tabs in our example.
• The "Summary" tab presents the ten longest processes. In our example, you can see that
the local procedure named "UpdateProductStock" takes more than 3 seconds to be run.

Part 6: Optimizing and debugging a project 387

 • The "Mapping" tab is used to visually identify what took the longest time. In our case, it is a
call to the Ping function:

388 Part 6: Optimizing and debugging a project

 • The "Details" tab presents all the processes run, from the slowest one to the fastest one.

The following information is displayed for each process:

• Function: Function, process or procedure run.
• Total time: Execution time of the function.
• Internal time: Execution time due to the engine.
• Nb calls: Number of calls made to the function (procedure or process).
• Time 1 call: Time for running a call to the function (procedure or process).
• % Code: Percentage of time spent in the process of the function or procedure (developer
code that can be optimized).
• Parent: Element that contains the process.
In our case, the "Details" tab indicates that the call to the "Ping" function is one of the
elements taking the longest time.
Select this line. We are going to check whether this slowdown is caused by a specific problem.

• Click the "Calls" button to display the details of the calls to the UpdateProductStock
procedure. Select the "Ping" line and click the "Code" button: the corresponding code line is
displayed in the code editor.

Part 6: Optimizing and debugging a project 389

 • Close the performance profiler.
• The following code line is run:
// Checks the accessibility of provider server
Ping("addr-provider")

The slowdown is caused by the fact that the address specified for Ping is not accessible.
Let's check the operating mode of the application by optimizing this code:
1. Replace the code line containing Ping by the following code line:
// Checks the accessibility of provider server
Ping("www.google.com")

2. Save the code (CTRL + S).

390 Part 6: Optimizing and debugging a project

We are now going to restart the performance profiler:
1. On the "Project" pane, in the "Audit and performances" group, expand "Analyze the
performances" and select "Analyze the performances".
2. The project test is run.
3. Click the "Test window of performance profiler" button.
4. Click the "Process to analyze" button.
5. Validate the information window and stop the project test. The report window of performance
profiler is displayed.
6. In the "Mapping" tab, the Ping function does not appear with the same importance.

Close the report window of performance profiler.

Part 6: Optimizing and debugging a project 391

 Lesson 6.4.  Debugging a project

This lesson will teach you the following concepts...

• Overview
• Using the debugger

Estimated time: 15 min

392 Part 6: Optimizing and debugging a project

 Overview
Let's take a look at the debugger supplied with WINDEV.
What is the debugger?
The debugger is a powerful tool used to follow the progress of a code or application, step by step.
Enhancing a process or even an application becomes child's play.
We are going to use the debugger on the long process found in the WIN_PerformanceProfiler
window.

Using the debugger

To debug the WIN_PerformanceProfiler window:

1. Open the "WIN_PerformanceProfiler" window in the window editor (double-click its name in
the project explorer).
2. Run the test of the "WIN_PerformanceProfiler" window ( among the quick access
buttons).
3. Start the debugger by using one of the following methods:
• Press the [CTRL] + [Pause] keys: the debugger will be automatically started during the next
user action in the checked window.
• Go back to the WINDEV editor and position a breakpoint in the code of the "Process to
analyze" button (click in front of the first code line of the click process or press [CTRL] + B, a
red dot appears). The debugger will be automatically started when the line preceded by the
breakpoint is run.

Several methods can be used to start the debugger. See the online help (keyword:
Note

"Debugger, Run a test") for more details.

4. Click the "Process to analyze" button. The debugger starts. The current line is preceded by
a little arrow.

Part 6: Optimizing and debugging a project 393

 The "Debugger" pane appears in the lower section of the screen. This pane displays two distinct
areas:
• the call stack: This area is used to find out the hierarchy of the processes displayed in the
debugger. In our example, we are currently debugging the click process on the BTN_LongProcess
button.
• the list of expressions to evaluate. The main variables used in the code are displayed in this
area. You have the ability to add variables in order to follow their evolution (this feature will be
presented later).
We are going to perform some operations in the debugger to discover its capabilities.
First of all, we are going to run the different statements step by step and see the content of
variables:
1. Press the [F8] key (or click the "Step by step" button found in the ribbon). The line following the
current line is automatically run. The values of variables are modified (if necessary) in the
"Debugger" pane (displayed at the bottom of the screen).
2. When the cursor shaped like an arrow reaches the "PROGBAR_Progress..MaxValue = ..."
line, hover "PROGBAR_Progress" with the mouse. A tooltip is displayed with the expression
value:

394 Part 6: Optimizing and debugging a project

 3. The value of "PROGBAR_Progress..MaxValue" is displayed in a tooltip. This value
corresponds to 100 because the code line was not run.
4. Press the [F8] key to run the line.
5. Hover "PROGBAR_Progress..MaxValue" again. The value of "PROGBAR_Progress..MaxValue"
displayed in the tooltip corresponds to the result of HNbRec(Product).

Let's continue our operations in the debugger. We are now going to run the
UpdateProductStock procedure step by step in the debugger.
1. To run this procedure step by step, press the [F7] key (or click the "Detailed step by step"
button in the ribbon).
2. The procedure code is displayed in the debugger.
We are now going to add an expression to monitor the evolution of its value in the "Debugger"
pane. This expression can have any type: variable, function, operation on variables, ... The
expression result is calculated and displayed.
This expression is used to perform a custom debugging. For example, you can find out the
content of a variable while it is being used in the application.
1. Press [F7] to run the different lines of the UpdateProductStock procedure until you reach the
line:

PROGBAR_Progress++
2. Hover "PROGBAR_Progress". The value displayed in the tooltip is 0.
3. Select "PROGBAR_Progress" in the code editor and display the popup menu (right mouse
click). Select "Add the expression to the debugger".

Part 6: Optimizing and debugging a project 395

 4. The expression is automatically added into the debugger pane at the bottom of the screen.

The debugger can also be used to run a set of code lines:

1. Press [F8] until you reach the line:

HModify(Product)

The [F8] key is used to run the code of the InterrogateSupplierDatabase procedure without
running it step by step in the debugger.
2. Click the following line with the mouse (caution: click inside the line and not in front of it):

IF HExecuteQuery(QRY_QuantityOrdered) THEN
3. Press the [F6] key (or click the "Run until cursor" button found in the ribbon).
4. The arrow indicating the line currently run moves until it reaches the code line where the
cursor is positioned. The code lines found before the cursor are automatically run.
We are now going to add a breakpoint and to run the code until it reaches the breakpoint:
1. Click in the hatched area with the mouse, in front of HModify. A breakpoint (red bullet)
appears.

2. Press the [F5] key (or click the "Continue" button found in the ribbon). The code is run until
it reaches the breakpoint. The arrow used to identify the current line moves until it reaches the
breakpoint.
396 Part 6: Optimizing and debugging a project
 3. Click the breakpoint to remove it.
To end this test, we will be using an "Auto-stop" expression. An "Auto-stop" expression is used
to start the debugger as soon as a condition is checked or when the value of a variable is
modified. In our example, the debugger will be started as soon as the value of the progress
bar is set to 50%:
1. In the "Debugger" pane, select the "PROGBAR_Progress" expression that was added
beforehand.
2. Click the green circle.
3. Press the [F5] key to continue the test.
4. A message is displayed, indicating that the value of the "PROGBAR_Progress" expression
changed.

5. Validate.
6. In the "Debugger" pane, select the "PROGBAR_Progress" expression. Click the expression
again: the "Expression" column becomes editable. In the "Expression" area, add "=50". You will
get "PROGBAR_Progress = 50".

7. Press the [F5] key. The program continues to run. The debugger is started again when the
value of the progress bar is set to 50.
That's it, we presented the main features of debugger. To stop the test in the debugger, click
"End the test" found in the ribbon.

Part 6: Optimizing and debugging a project 397

 398 Part 6: Optimizing and debugging a project
 PART 7

Advanced
programming
 400 Part 7: Advanced programming
 Lesson 7.1.  Overview

This lesson will teach you the following concepts...

• Overview
• How to open a training example
• How to open a unit example

Estimated time: 5 min

Part 7: Advanced programming 401

 Overview
This section presents several advanced features. You don't necessarily have to read it but it will
allow you to discover some advanced features proposed by WINDEV.
The different lessons found in this section are based on examples supplied with WINDEV.

WINDEV proposes different types of examples:

• complete examples: these examples correspond to a complete application that is using one or
more features.
• training examples: these examples correspond to a small application allowing to discover a
specific feature.
• unit examples: these examples correspond to a window allowing you to quickly check the use of
a function.

Practical example
To simplify the presentation of different features, we will be using unit examples or training
examples supplied with WINDEV.
To open a complete example, a training example or a unit example from the home window:
1. Display the home window (CTRL + >).
2. In the home window, click "Open an example". The list of complete examples, training
examples and unit examples supplied with WINDEV is displayed. These examples are grouped
by type of example (complete, training, ...).
3. In the search area, you have the ability to type a keyword (type "Error" for example). Only the
examples containing this word are listed.

4. To open an example, all you have to do is click the link found in the window.
5. For the complete and training examples, the current project is automatically closed and the
sample project is opened.
6. For the unit examples, the associated window is opened in the current project.

402 Part 7: Advanced programming

 Lesson 7.2.  Automatic management
of errors

This lesson will teach you the following concepts...

• What is the automatic management of errors?

• Using the automatic management of errors.

Estimated time: 10 min

Part 7: Advanced programming 403

 Overview
The errors can be automatically managed by WINDEV. This feature helps you reduce the number
of code lines while centralizing the management of errors.
The use of this feature also makes the code easier to read.

Operating mode
Two operations are performed when an error is detected by a WLanguage function:
• a return value of error is returned by the function (fOpen returns "-1" if the specified file was
not opened for example).
• the error is detected by WLanguage (the ErrorDetected variable is set to True) and the error
details are returned by ErrorInfo.
This second operation can be automatically managed by the error management of WINDEV.

Implementation
The automatic management of errors can be configured:
• in the code editor: all you have to do is click the "If error: by program" link in the code editor:

• by programming with ErrorChangeParameter.

404 Part 7: Advanced programming

Types of affected errors
Two types of errors can occur in WLanguage:
• the "non-fatal" errors (also called runtime errors): in most cases, these errors are managed
in the code and they do not stop the application. For example, opening a file that cannot be
accessed or an archive that does not exist.
• the "fatal" errors (also called programming errors): in most cases, these errors are linked to
development problems (access to a non-declared file, use of non-existing controls, ...). A
"fatal" error can also occur after a "non-fatal" error that was not processed properly. In this
case, the application will be stopped.
The mechanism for managing errors is used to manage these two types of errors according to
different methods in order to specify behaviors adapted to the errors that occur.

Automatic management of errors: a training example

To understand the different error cases, we will be using a training example supplied with
WINDEV.
1. Close the current project if necessary. The home window is displayed.
2. In the home window, click "Open an example". The list of complete examples, training
examples and unit examples supplied with WINDEV is displayed.
3. Type "Error" in the search area. Only the examples containing this word are listed.

4. Select the "WD Auto Error Management" project. The project is loaded.

This project presents the management:

• of a non-fatal error (opening an archive that does not exist).
• of a fatal error (division by 0).
• of an error on several levels.
Run the project test by clicking (among the quick access buttons).
1. Click "Managing a non-fatal error".
2. The following window is displayed.

Part 7: Advanced programming 405

 3. Click the "Test this error management" button.
4. When running the code line that triggers the error, an error message is displayed, allowing
the user to retry the operation, cancel the operation or stop the application. The "Debug"
option should be used:
• in test mode, to debug the application directly.
• in executable mode, to debug an executable directly from WINDEV.
5. Click "Cancel the operation" and close the window.

406 Part 7: Advanced programming

Click "Managing a fatal error".
1. The following window is displayed. This window is used to check the error when an integer is
divided by 0.

2. Click the "Test this error management" button.

3. When running the code line that triggers the error, a procedure is automatically called. This
procedure is used to display the error message and to stop the current process.
4. Click "OK" and close the window.

Part 7: Advanced programming 407

 Click "Managing an error on several levels".
1. The following window is displayed. This window is used to test an error on several levels
(process calling a procedure that opens a non-existing archive).

2. Click the "Test this error management" button.

3. When running the code line that triggers the error:
- the procedure returns "False" to the calling process.
- the calling process displays an error message and stops the process.
4. Click the "Cancel the operation" button.

Stop the application test.

Example

WINDEV also proposes an automatic management of HFSQL errors. See the

"Detecting HFSQL errors" training example (supplied with WINDEV) for more
details. This example can be accessed from the home window of WINDEV.

408 Part 7: Advanced programming

 Lesson 7.3. Handling external files

This lesson will teach you the following concepts...

• Handling text files (CSV , ...)

• Handling directories
• Handling XML files
• Handling XLS files

Estimated time: 20 min

Part 7: Advanced programming 409

 Overview
WINDEV allows you to easily handle the most common data formats:
• text files (INI, CSV, ...),
• XML files,
• XLS files, ...
Several families of WLanguage functions can be used to read and create these files. This allows
you to easily read data generated by another software in your WINDEV applications or to create
files that require a specific formatting.
Furthermore, several WLanguage functions can be used to handle the directories containing the
files.
In this chapter, we will focus on:
• Text files (text files, INI files and CSV files),
• XML files,
• XLS files,
• managing directories.

Handling text or CSV files

Overview
The external files are also called text files or files with direct access. In most cases, this type of file
contains text but it can also contain binary information such as images, sounds, ...
In this lesson as in the entire WINDEV documentation, we will be talking of external files.
WINDEV allows you to handle the external files by programming. The WLanguage functions can be
used to create, read... external files. All the functions can easily be identified: they start with the
letter "f".
The notion of "record" does not necessarily exist in an external file. To handle an external file, you
must know its structure, which means how the data is organized inside the file.
The CSV files are text files that use a specific structure. Therefore, they can be handled like the
text files.
The .INI files are also text files that use a specific structure. Two specific functions are used to
handle them: INIRead and INIWrite.

Practical example

Open the unit example named "Handling text files".

Run the test of "WIN_Text_File" window. This window groups the different operations that can
be performed on the external files with WINDEV.

410 Part 7: Advanced programming

 The different window tabs propose to:
• Create a text file.
• Read and write in a text file.
• Handle existing files (copy, deletion, read information, ...).
• Copy a text file.
See the online help (keyword: "External file") for more details.

Handling directories
Several WLanguage functions are used to handle the directories and their files.

Practical example

Open (if necessary) the training example named "Handling directories" and run the test of the
corresponding window.
This window groups the operations that can be performed on the disks and directories:
• create a directory,
• find out the current directory,
• check the existence of a directory,
• list the directories,
• copy and create a directory, ...
See the online help (keyword: "External file") for more details.

Part 7: Advanced programming 411

 Handling XML files

Overview
XML (Extensible Markup Language) is a markup language, which means a language that presents
information enclosed in tags. XML is a metalanguage that is used to invent new tags to isolate the
elementary information that may be found in a Web page.
XML is used to structure a document containing data. A HFSQL data file containing several items
and records can be exported to an XML file for example (XML* functions).

WINDEV supports:
• the files in XML format via a native access supplied with WINDEV. See the online help for
more details.
• the export to XML (TableToXML, TextToXML, HExportXML)
• the import of XML data (HImportXML)
• the use of an XML document via the advanced XMLDocument type and via the WLanguage
functions starting with XML.

The XML file can also be handled in the code editor directly. You must:
1. Drop the XML file from the file explorer to the project explorer, "XML and XSD descriptions"
folder.
2. Drop the XML file from the project explorer to the code editor. The xmlDocument variable is
automatically created as follows:
<Variable Name> is xmlDocument, description = <Document Name>

3. You now have the ability to access the variable nodes by their names. These names are
automatically proposed by the mechanism for automatic completion of the code editor.

412 Part 7: Advanced programming

Practical example

Open the unit example named "Reading and writing in XML format".
Run the test of "WIN_XMLOperations" window. This window is used to:
• create an XML file. This file is created by the XML functions.

• read an XML file.

Study the code associated with each button.
Notes

We won't go into details about all the features proposed by the XML functions.
See the online help for more details.

Handling XLS files

To handle the Excel files, WINDEV proposes:
• the xlsXXX functions. These functions are used to read the data found in the different worksheets
of an Excel file.
• the advanced variables (xlsDocument, xlsRow, xlsColumn, xlsCell).

Part 7: Advanced programming 413

 Practical examples
Let's see the features of these functions?
To check the use of xlsXXX functions, open the unit example named "The Excel functions".
Run the test of "WIN_XLSFunction" window. This window is used to:
• import data coming from an Excel worksheet.
• export data from a Table control to Excel.
Go back to the editor and study the code of the different buttons.
To check the use of advanced variables, open the unit example named "XLS type".
Run the test of "WIN_XLS_Type" window.

Go back to the editor and study the code of the different buttons.
Notes

We won't go into details about all the features proposed by the XLS functions and
the advanced types. See the online help for more details.

414 Part 7: Advanced programming

 Lesson 7.4.  Dynamic compilation

This lesson will teach you the following concepts...

• Overview
• Drawing a line in dynamic compilation

Estimated time: 20 min

Part 7: Advanced programming 415

 Overview
The dynamic compilation is used to compile a code at any time in the application. A common
example? Your application contains a formula that can be configured. To change the parameters,
there is no need to supply the executable again: the modification of a text file is sufficient.

Example
The dynamic compilation will be presented via the unit example named "Dynamic compilation".
The "Dynamic compilation" window explains how to dynamically compile WLanguage code (stored
in string format), run the procedure that was dynamically generated and process the possible
runtime errors.
To run the test of this window:
1. Open the unit example named "Dynamic compilation".
2. Run the test of "WIN_DYNAMIC_COMPILATION" window.

3. Click the different "Run" buttons to see the different cases.

4. Stop the test.

416 Part 7: Advanced programming

Let's go back to the code editor and study the code of the first "Run" button.
1. Display the code of the "Run" button (right click on the button, "Code" option). This code calls
the CompileDynamicCode procedure.
2. Position the mouse cursor on the name of the procedure and press [F2]. The code of the
procedure is automatically displayed in the code editor.
The code of this procedure can be divided into several sections:
1. Initializing variables.
2. Compiling the code.

sCompilationResult = Compile(DYNAMIC_PROCEDURE, ...

EDT_COMPIL_CODE)

This code highlights several important topics:

• The function is compiled by Compile. The function that is dynamically compiled becomes
usable as soon as this function is called (and if no error is returned).
• This function expects two parameters: the name of the compiled procedure ("DYNAMIC_
PROCEDURE") and the code to compile. In this case, the code to compile is found in the edit
control named EDT_COMPIL_CODE.
• The result of the compilation is assigned to a sCompilationResult string.
3. Checking the compilation result.

// Checks the compilation result

SWITCH sCompilationResult
// No error
CASE ""
bCompilationResult = True
STC_ERROR_COMPILED_CODE = ""

// Fatal compilation error
CASE "ERR"
bCompilationResult = False
STC_ERROR_COMPILED_CODE = ErrorInfo()
// Incorrect code
OTHER CASE
bCompilationResult = False
STC_ERROR_COMPILED_CODE = sCompilationResult
END

4. Press the [CTRL] + [F2] keys. The click code of the "Run" button re-appears in the code
editor. In the rest of this code, you can see that the function that is dynamically compiled is run
by Execute.

Part 7: Advanced programming 417

 Lesson 7.5.  Windows event

This lesson will teach you the following concepts...

• Programming the Windows events.

Estimated time: 10 min

418 Part 7: Advanced programming

Introduction
Each action performed by Windows corresponds to a Windows event. Different types of events can
occur, for example:
• A window is hovered by the mouse,
• The system is stopped,
• A dialog box is displayed,
• A software error,
• Etc.
When these events occur, they can be intercepted in order to prepare or to run a specific process.
WINDEV proposes an automatic management of the most common events. For example, the
following events are proposed for an edit control:
• Initializing the control,
• Entry in the control,
• Modifying the control,
• Exit from the control.
To manage additional events, you can:
• use the optional processes proposed by WINDEV.
• use the Windows events.

Practical example
The management of events will be presented via the unit example named "The Event function".
Open the unit example named "The Event function".
Optional processes proposed by WINDEV
Several optional processes are proposed for each element (window, control, ...).
To add an optional process:
1. Display the processes linked to the List Box control found in the window of the unit example:
• Select the List Box control.
• Press the [F2] key.
• The code editor is displayed.

Part 7: Advanced programming 419

 2. A toolbar is available at the bottom of the code window:

This toolbar presents the main available optional processes. To identify the processes, hover
the different icons.
3. To add a process, click the corresponding icon. The corresponding process is automatically
displayed in the code editor.
4. To display the full list of available optional processes, all you have to do is click "...".

5. To add a process, all you have to do is check the corresponding box and validate this
window. Add the "Key Pressed" event for example.

Windows events
To manage more "specific" events, you have the ability to use the WLanguage Event function. This
WLanguage function is used to associate a WLanguage procedure to a Windows event.
Notes

To use the Event function, you must be familiar with the Windows programming,
especially the Windows events.

See the online help of WINDEV (keyword: "Value of constants for the Windows API") to find out the
list of Windows events.

420 Part 7: Advanced programming

Example: Detecting the click on a list

Run the test of "WIN_Event_Function" window. This window detects whether the list is
handled by the mouse or by the keyboard.
1. Click the List Box control with the mouse.
2. Use the mouse to move the selection bar.
3. A message is displayed, specifying whether the mouse or the keyboard was used.

4. Stop the test and go back to the editor.

Let's study the code used:
1. Click in the window.
2. Display the window processes (press [F2]).
3. Let's study the declaration code of global variables of the WIN_Event_Function window.
• First of all, the code line:
EXTERN "WINCONST.WL"
• This code line is used to include the content of the WINCONST.WL file in the application
code via the EXTERN keyword. This file contains the declaration and values of the Windows
constants. During the compilation, the entire code found in the WINCONST.WL file will be
automatically included in the application code.
• Then, all the supported events are declared:
// Events on LIST_Month control
// Keyboard key down
Event("MouseOrKeyboard", LIST_Month..FullName, ...
WM_KEYDOWN)
// Left mouse click
Event("MouseOrKeyboard", LIST_Month..FullName, ...
WM_LBUTTONDOWN)

Part 7: Advanced programming 421

 The MouseOrKeyboard procedure is called whenever the keyboard is used on the list
(corresponding Windows event: WM_KEYDOWN) or whenever the left mouse click is used
(corresponding Windows event: WM_LBUTTONDOWN).
4. Display the procedure code:
• Position the mouse cursor on "MouseOrKeyboard".
• Press the [F2] key.
5. The procedure code is straightforward:
• If the keyboard is used, the caption displayed below the List Box control contains "Selection
with the keyboard".
• If the mouse is used, the caption displayed below the List Box control contains "Selection
with the mouse".

PROCEDURE MouseOrKeyboard()
// The _EVE.wMessage variable contains the message number
SWITCH _EVE.wMessage
// Keyboard
CASE WM_KEYDOWN
// Message indicating that the keyboard is used
STC_SelectionType = "Selection with the keyboard"
STC_SelectionType..Color = LightRed

// It's the mouse
CASE WM_LBUTTONDOWN
// Message indicating that the mouse is used
STC_SelectionType = "Selection with the mouse"
STC_SelectionType..Color = LightBlue
END

422 Part 7: Advanced programming

 Lesson 7.6.  The threads

This lesson will teach you the following concepts...

• What are the threads?

Estimated time: 10 min

Part 7: Advanced programming 423

 Definition
The threads are used to run a code (or processes) in parallel of the main application. Therefore,
several long processes can be run in background task without locking the main application (also
called "Main thread").
The threads replace some types of timers.
In most cases, a secondary thread is used to detect an event such as a user action, an incoming
email, a phone call,...

Examples for using threads:

• Retrieving emails in background task while typing a new email.
• Application for communication: management of phone calls, communications via socket, ...
WINDEV allows you to:
• manage the threads (Thread* functions).
• use "signals" in order to synchronize several threads (Event* functions).
• use the threads with "semaphores" in order to manage the access to the resources shared
by different threads (Semaphore* functions).

Example

WINDEV is supplied with several unit examples allowing you to understand the
Example

benefit and the use of threads:

• The threads (Pool).
• The threads.

See the online help (keyword: "Thread") for more details.

424 Part 7: Advanced programming

 Lesson 7.7.  The sockets

This lesson will teach you the following concepts...

• Overview
• Server application
• Client application

Estimated time: 20 min

Part 7: Advanced programming 425

 Overview
WINDEV proposes several functions used to perform an advanced management of sockets.
A socket is a communication resource used by the applications to communicate between
computers regardless of the network type.
This communication mode is used to establish a communication between two applications found
on different computers (connected by Internet or on the same local network) or on the same
computer.
A WINDEV application can manage the sockets according to different modes:
• Client WINDEV application: the application connects to a standard server and exchanges
data via a socket.
• WINDEV, WEBDEV or WINDEV Mobile "Server" application: the WINDEV, WEBDEV or WINDEV
Mobile application is a server, exchanging information by sockets with several client
computers. The threads must be used to manage several simultaneous connections.
Example

WINDEV is supplied with a training example allowing you to understand the use
of sockets: "WD Using sockets". This example can be accessed from the home
window of WINDEV (CTRL <).

Server application: simplified server

WINDEV gives you the ability to create a simplified socket server. This server is used to
communicate with a single client computer at a time. This type of application is very useful when
two remote applications must communicate between themselves.
The steps for creating a simplified server are as follows:
1. Creating the socket.
2. Exchanging data.
3. Closing the socket.

Creating the socket

To create the socket, the server is using SocketCreate. A socket is associated with a specific port.
For a simplified use of socket by programming on the server, specify the name of the socket.
The client computer will connect to this socket in order to exchange data. The connection between
the two computers will be actually established during the first exchange of data between the two
computers (which means when the server reads information for the first time).
The connection is established during the first successful attempt of SocketRead on the server.

Exchanging data
When two computers are using the same socket, a communication stream is established between
these two computers. These two computers can read and write character strings on the socket.
Note: To avoid locking the applications, the incoming messages are managed by a specific thread
in most cases.
To read and write on the socket, the WINDEV server application must use SocketRead and
SocketWrite.
426 Part 7: Advanced programming
Caution: To perform a read operation, a write operation must have been performed beforehand.
For example:
1. The client computer writes into the socket: it sends a request to the server.
2. The server performs a read operation on the socket in a thread. As soon as a message is
received, the message is processed by the server.
3. If a response to the message is required, the server identifies the client computer
(SocketClientInfo) and sends a response to it.

Closing the socket

To end the communication, the server can close the socket with SocketClose.
Note: the socket can also be closed by the client computer.

Client application
A client application of a socket server connects to a standard server in order to exchange
information via a socket.
Example: A client WINDEV application can connect to a standard news server on Internet.
The steps for creating a client application are as follows:
1. Connecting to the server.
2. Exchanging data.
3. Ending the communication.

Connecting to the server

To connect to a server socket, all you have to do is use SocketConnect. This function is used to
perform a request for connecting to the server.
The socket is identified by its port and by its address.

Exchanging data
When two computers are using the same socket, a communication stream is established between
these two computers. These two computers can read and write character strings on the socket.
Note: To avoid locking the applications, the incoming messages are managed by a specific thread
in most cases.
To read and write on the socket, the WINDEV client application must use SocketRead and
SocketWrite.

Ending the communication

To end the communication, all you have to do is close the socket from the client computer with
SocketClose.
Note: you also have the ability to end the communication from the server.

Part 7: Advanced programming 427

 Practical example
The programming of sockets will be presented via the unit example named "Using sockets".

Example test

Open the unit example named "Using sockets".

Run the test of "WIN_Socket" window. A message will be sent from computer B to computer A.
Computer A is the Server application and computer B is the Client application.
1. On computer A, click the "Create" button to create the socket.
2. Computer B can connect to the socket created by computer A. All you have to do is click the
"Connect" button (in Computer B section).
3. Computer B sends a message to computer A:
• Type message to send in the "Sentence to send to computer A" area.
• Click the "Send" button found in the "Computer B" area.
4. To retrieve the message on computer A, click the "Get" button found in the "Computer A"
area.
5. Click the "Disonnect" buttons to disconnect the two computers.
Stop the window test to go back to the editor.
Analyzing the code used

Let's study the code of the different buttons that have been used.
First of all, we are going to study the processes performed by the socket server (computer A).
1. Display the code of the "Create" button found in the "Computer A" area:
• Select the "Create" button.
• Press [F2] to display the processes.
2. In the "Click" process, you will notice the presence of SocketCreate that is used to create
the socket. Close the code editor.
3. Display the code of the "Get" button found in the "Computer A" area:
• Select the "Get" button.
• Press [F2] to display the processes.
4. The following code is used in the "Click" process:
EDT_SentenceReceivedFromComputerB = ...
SocketRead("ComputerA", False, 2000)
IF EDT_SentenceReceivedFromComputerB <> "" THEN
Info("Message received from the IP address # "+...
SocketClientInfo("ComputerA", SocketAddress))
END

You will notice the presence of SocketRead that is used to read the socket that was created
beforehand. The message read is immediately displayed in the "EDT_
SentenceReceivedFromComputerB" control. Close the code editor.

428 Part 7: Advanced programming

Let's study the processes performed by the client (computer B).
1. Display the code of the "Connect" button found in the "Computer B" area:
• Select the "Connect" button.
• Press [F2] to display the processes.
2. In the "Click" process, you will notice the presence of SocketConnect, which is used to
connect to the socket created by computer A. Close the code editor.
3. Display the code of the "Send" button found in the "Computer B" area:
• Select the "Send" button.
• Press [F2] to display the processes.
4. The following code is used in the "Click" process:

IF NOT SocketWrite("ForComputerA", ...

EDT_SentenceToSendToComputerA) THEN
Error(ErrorInfo(errMessage))
RETURN
END

You will notice the presence of SocketWrite which is used to send a message onto the socket
to which computer B is connected. Close the code editor.

Note: In this lesson, we have seen a "simple" communication between a server and a client
computer: the client sends messages and the server processes the messages. You have the ability
to create more complex applications.
You have the ability to establish a communication between two applications, both client and
server. In this case, the management of threads becomes very important to manage the send
operations and the responses.

Part 7: Advanced programming 429

 Lesson 7.8.  The FTP

This lesson will teach you the following concepts...

• Presenting the FTP functions of WINDEV.

Estimated time: 20 min

430 Part 7: Advanced programming

Overview
The FTP (File Transfer Protocol) is a standard protocol used to transfer files from a computer to
another one. One of the computers must be an FTP server.
Several WLanguage commands allow you to transfer files by using this protocol with a server.
These programming functions start with "FTP".
WINDEV only proposes "client" functions for the FTP. A standard FTP server is required.

The unit example named "The FTP functions" presents the operations that can be performed on
the files found on an FTP server.
Open the unit example named "The FTP functions". This example presents the main features
that can be used on an FTP server.

Connecting to an FTP server

The FTPConnect function is used to connect to an FTP server. An FTP account (user name and
password) is required to access an FTP server.

Display the code of the "Connection" button found in the "WIN_FTP" window:
1. Select the "Connection" button.
2. Press [F2] to display the associated code:

// 1 - FTP address: corresponds to the FTP site

// to which the application must connect. Ex: 192.108.10.2
sFTPAddress is string = EDT_Server_FTP
// 2 - User name: if this name is not specified,
// an "anonymous" connection will be used
sUserName is string = EDT_User
sUserPWD is string = EDT_Pass_word

Part 7: Advanced programming 431

 // Connection to the FTP server
gnConnectionID = FTPConnect(sFTPAddress,sUserName,...
sUserPWD)
IF ErrorOccurred THEN
// An error occurred during the connection
Error("The connection to the FTP server: "+...
sFTPAddress+" failed",ErrorInfo())
RETURN
END
// The connection is established
Info("The connection to the FTP server is established",...
"connection identifier: "+gnConnectionID)

Note: You also have the ability to specify the port number for connecting to the FTP server ("21" by
default) as well as the connection mode ("True" for a "passive" connection, "False" for an "active"
connection). See the online help (keyword: "FTP, Functions") for more details.

Sending a file
To send a file to an FTP server, all you have to do is use FTPSend.
Let's see a code sample that can be used:
// When connecting to the server with FTPConnect, we have
// retrieved the connection number in the gnConnectionID variable
// Transfer the "C:\MyDocuments\File.DOC" file to
// the "Temp" directory found on the server.
bResult is boolean = FTPSend(gnConnectionID, ...
"C:\MyDocuments\File.DOC", "/Temp")

Pay great attention to the case (uppercase/lowercase characters) for the name
of directories on the server. Indeed, some FTP servers operate under UNIX and
are "case sensitive", which means that the case is taken into account for the
Caution!

name of files and directories.

For example, a directory named "MyDirectory" is found on the FTP server. If you
try to access "mydirectory", an error such as "Path not found" will be returned by
the FTP server because the case is incorrect.

432 Part 7: Advanced programming

Listing the files found on an FTP server
The FTPListFile file is used to list the files found on an FTP server. This function is using a "callback"
procedure. The procedure is run for each file or directory found.

Display the code of "List" button found in the "WIN_FTP" window:

1. Select the "List in a trace" button.
2. Press [F2] to display the associated code:
FTPListFile(gnConnectionID,"*.*",...
"FTPFileListCallBack",ftpFile+ftpDirectory)

// Check the execution of the function

IF ErrorOccurred THEN
Error("Error while browsing the files found on the FTP server",
ErrorInfo())
RETURN
END

3. In the example, the procedure called is used to display the files found in a trace window.

PROCEDURE FTPFileListCallBack(sFileName,nFileSize
<useful>,sAttribute,sModifDate <useful>,sModifTime <useful>)

// Is it a file or a directory
IF sAttribute = "D" THEN
// Directory or sub-directory
Trace("Directory: "+sFileName)
ELSE
// File
Trace("File: "+sFileName)
END

// Continue to browse the files

RESULT True

Part 7: Advanced programming 433

 Retrieving a file
To retrieve a file from an FTP server, all you have to do is use FTPGet.
Let's see a code sample that can be used:
// When connecting to the server with FTPConnect, we have
// retrieved the connection number in the gnConnectionID variable
// Download the "/Document/File.DOC" file found
// on the FTP server to the "D:\Temp" directory on
// the current computer
bRes is boolean = FTPGet(gnConnectionID, ...
"/Document/File.DOC","D:\Temp")

Disconnecting from an FTP server

To disconnect from an FTP server, use FTPDisconnect.
Display the code of "Disconnection" button found in the "WIN_FTP" window:
1. Select the "Disconnection" button.
2. Press [F2] to display the associated code:

IF YesNo(No, ...
"Do you want to close the connection to the FTP server ?")=Yes ...
THEN
// Disconnect from the FTP server
FTPDisconnect(gnConnectionID)
IF ErrorOccurred THEN
// Error while closing the connection
Error("Unable to close the FTP connection",ErrorInfo())
RETURN
END

// The connection is ended
Info("The connection to the FTP server is ended")
END

Other FTP functions are available but we won't go into details about them in this tutorial. They are
mainly used to:
• create, delete, modify directories on the FTP server,
• create, delete, modify files on the FTP server,
• retrieve information about a directory and/or a file,
•  ...

See the online help (keyword: "FTP, Functions") for more details.

434 Part 7: Advanced programming

Lesson 7.9.  The OOP

This lesson will teach you the following concepts...

• Concepts of object-oriented programming.

• Examples of object declaration.
• Associated UML model.

Estimated time: 30 min

Part 7: Advanced programming 435

 Concepts
The Object-Oriented Programming (OOP) is designed for better code reusability. The programs
developed in OOP are structured: they include modules, each one of these modules being used
to manage a feature of the software. These modules can easily be re-used in other software. They
group a set of procedures (called methods) and they encapsulate the data structure on which the
methods will act.
To use the object-oriented programming, you must declare the classes, the members and the
associated methods.

The classes
A class contains the description of a data structure (the members) and the procedures (methods)
that handle the members.
Therefore, a class defines a type of data and its behavior.

The objects
A class is used to create objects. Each created object owns the members described in its class
and it can be handled via the methods of its class. An object is defined as an instance of the class.
When the class is declared, all you have to do is associate an object with a class in order for the
object to be handled by all the methods of this class.

The members
A member is a data (or parameter) of the object.

The methods
A method is used to act on the object, to modify its members for example.
A method is a procedure. Its operating mode is similar to the one of the standard procedures of
WLanguage.

Concept of inheritance
The inheritance is used to include the characteristics of an existing class (base class) in a new
class (derived class). The inheritance allows you to create a new type of data from a known type in
order to add features to it or to modify its behavior. Therefore, the base class will not be modified.
A class can inherit from a class: it becomes a sub-class of this class.
The objects found in a derived class can access all the methods, all the members and all the
properties of the ancestor classes ; it is as if the methods, the members and the properties of the
ancestor classes were part of the derived class.

436 Part 7: Advanced programming

Constructor and Destructor
The notions of Constructor and Destructor are important because they allow for an automatic call
to initialization methods when creating an object and when destroying it.
The Constructor method associated with a class is automatically called when declaring an object
of the class.
The Destructor method associated with a class is automatically called when deleting the object
(exit from the procedure where the object was declared).

Data encapsulation
The data encapsulation is used to ensure that the data belonging to the object is not accidentally
modified by functions (methods) external to the object.
This allows you to prevent the user of an object from accessing some or all of its members. The
members whose access is forbidden are called private members.
These private members can only be accessed from the methods designed for this purpose in the
class.

Example
Let's take a simple example to apply these concepts:
• Let's consider the PERSON class.
• Florence is an instance of the PERSON class.
• The last name, first name and date of birth can be members of the PERSON class.
• The Age[] method can be a method of the PERSON class. It would calculate the age according to
the "date of birth" member and according to todays' date (returned by DateSys).
• Inheritance: A contact can be either a person, or a company.
• PERSON could be a class derived from CONTACT.
• COMPANY could be a class derived from CONTACT.

Creating an object-oriented program

To create an object-oriented program in WLanguage, you must:
1. Describe the class and the members of the class.
2. Specify all the methods of the class.
3. Declare the objects by associating them with a class ("instantiate a class").

Part 7: Advanced programming 437

 Simple example

To illustrate these concepts, we will be using the training example named "WD Simple OOP".
1. Open the training example named "WD Simple OOP".
2. Run the test of this example.

3. Click the different buttons corresponding to the animals in order to add them.
4. Stop the example test to go back to the editor.
Note: We won't go into details about the syntax of OOP but we will present a simple example of an
object-oriented program. See the online help (keyword: "OOP, Class") for more details.

Declaring a class

WINDEV allows you to easily declare the classes from the project explorer. To create a class:
1. In the project explorer, select the "Classes" folder.
2. Display the popup menu of this folder (right mouse click) and select "New class".
3. In the window that is displayed, specify the class name (TestTUT for example) and validate.
4. To display the code of the class in the code editor, double-click its name in the project
explorer.

Study the code of the cSavanna class used in the example.

1. In the project explorer, select the "Classes" folder.
2. Open the "Classes" folder (to do so, click the arrow found in front of the folder name).
3. Double-click the cSavanna class.

438 Part 7: Advanced programming

 4. The code of the class is displayed in the code editor. The declaration code of the class has
the following format:
cSavanna is Class

PROTECTED
// Name of Image control used for the drawing
m_sNameImageControlForDrawing is string
// List of savanna animals
m_arrTheAnimals is array of cAnimal dynamic
END
"cSavanna" is the name of the class.
"m_sNameImageControlForDrawing" and "m_arrTheAnimals" are members of the class.
The "PROTECTED" keyword is used to specify that these members can only be handled from a
code of the class or from a code of a derived class.

Describing the methods

WINDEV allows you to easily declare the classes from the project explorer. To create a
method:
1. Right-click your class found in the project explorer.
2. Select "New method" from the popup menu.
3. In the window that is displayed, specify the name of the method and validate.
4. Enter the code of the method in the code editor.

To display the AddAnimal method of the cSavanna class:

1. Click your class found in the project explorer.
2. Click the little arrow found in front of the class name: the different methods of the class are
displayed.
3. Double-click the method name:

PROCEDURE AddAnimal(pclAnAnimal is cAnimal dynamic)

// No more than 5 animals

IF m_arrTheAnimals..Occurrence = 5 THEN
Error("No more than 5 animals !")
RESULT False
END

// Adds the animal to the list

Add(m_arrTheAnimals, pclAnAnimal)

// Draws the savanna

DrawSavanna()

RESULT True

Part 7: Advanced programming 439

 Declaring and handling the objects
In the processes of the window, an object is declared at the same time as the other variables:
// Global declarations of WIN_OOP
PROCEDURE WIN_OOP()

// Savanna object
gclTheSavanna is cSavanna(IMG_Landscape..FullName)

To refer to a member of the "cSavanna" object, use the following syntax

<ObjectName>.<member name>

In our example, the object is handled:

• When initializing the window, to build the savanna.
// Draws the savanna
gclTheSavanna.DrawSavanna()
• When creating an animal, to position the animal in the savanna.

// Declares a new elephant

clElephant is cElephant("Elephant "+GetIdentifier(), 13)

// Adds the elephant into the savanna

// (this action refreshes the drawing)
IF gclTheSavanna.AddAnimal(clElephant) THEN
// End message
ToastDisplay("Animal added", toastShort, vaMiddle, haCenter)

END

We won't go into details about OOP in this tutorial.

440 Part 7: Advanced programming

UML diagram
The "WD Simple OOP" example is associated with an UML diagram.
To display the UML diagram linked to the project:
1. Double-click "UMLModel" in the project explorer:

2. The UML diagram (class diagram) linked to the project is displayed.

3. The different classes used by the "WD Simple OOP" project are found in this diagram.

Part 7: Advanced programming 441

 WINDEV allows you to create the 9 types of UML diagrams.
To create a UML diagram:
1. On the "Home" pane, in the "General" group, click "New".
2. The window for creating a new element is displayed: click "Architecture"
then "UML".
3. The wizard for creating a UML model starts, allowing you to choose the
model to create:
Notes

We won't go into details about the use of UML language with WINDEV. See the online help
(keyword: "UML") for more details.

442 Part 7: Advanced programming

 PART 8

Appendices
 444 Part 8: Appendices
 Appendice 1.  Vocabulary

This lesson will teach you the following concepts...

• The terms used by WINDEV, WEBDEV and WINDEV Mobile

Estimated time: 1 hour

Part 8: Appendices 445

 Main terms used

AAF
Abbreviation of Automatic Application Features.

Alignment
Method for organizing the controls in a window or in a page. For example, centering a control in a
window, set several controls to the same width, ...

Analysis
Describing the structure of data files (or tables) and their relationships.

Anchoring
Mechanism used to define the positioning or resizing rules in order for the window or page content
to automatically adapt when a window or a browser is resized.

Application RAD
Fast development method of a program from a program template.

Assignment
Operation that consists in assigning a value in a variable or in a control. For example:
// Assign the value MOORE to the CustomerName variable
CustomerName = "MOORE"

The = sign is the assignment operator.

Break (Report, Looper, Table)

Mechanism that consists in grouping and separating the data according to a value.
For example, create a break in a report that is used to list the customers by city. The customers
who live in the same city are grouped together. Visually, the customers are separated whenever
the city changes.

Class
Element defined in Object-Oriented Programming (OOP). A class groups methods (actions) and
members (data).

Classic
Type of access to a HFSQL file. A HFSQL file is a Classic file when it is directly accessed in its
directory.

Client/Server
Type of access to a HFSQL file. A HFSQL file is a Client/Server file when it is accessed by
connecting to a server containing this file via the HFSQL engine.

446 Part 8: Appendices

Control (window or page)
Graphic element used to build the GUI of a program or site.

Control template
Container of one or more controls (with processes) that can be indefinitely re-used in windows or
pages.

Database
Element containing the program data. The data is organized in files or tables.

Data binding
Method that is used to associate a graphic element of the GUI to a data found in a variable, an
item, an array...

Deployment
Action that consists in installing a program on the user computer or on a server.

Editor
Program that is used to create a project element (window editor, page editor, ...)

Event programming
Type of programming. A user action on a window or on a page induces a code to run. The code of
the action to run is typed in the event representing the user action.
For example, the “Button click” event corresponds to a mouse click performed by the user on this
button.

External component
Software brick that is used to export one or more business rules in order to re-use them.

File
Element that constitutes a database. A file is used to store the data entered in a program.
For example, a CUSTOMER file will contain the customer information that was entered in a
program.
Synonym: Table

Global (variable or procedure)

Corresponds to the scope in memory of a variable or procedure. A global element is accessible
from any other project element. The opposite is local.

GUI
Abbreviation of Graphical User Interface. Description of windows or pages that constitute a
program. This is what the user will see when using the program.

Part 8: Appendices 447

 Homothetic
Method for resizing an image in order to maximize it without distorting its content.

Index (file)
Synonym: key

Integrity constraint
Rule to respect associated with a file item in order to insure the consistency of data in a database.

Item
Element that belongs to the structure of a data file or table (found in an analysis). For example, a
CUSTOMER file can include the FirstName and LastName items.

Internal component
Container that groups elements found in a project (window, page, query, report, class, ...) in order
to allow and simplify a share with another project.

Key
Characteristics of a file item. A key item is used to optimize the searches and the sorts in a data
file.
Synonym: index

Link in an analysis
Describes the nature of the relationship or the common point between 2 analysis files. From a
link, consists in describing the integrity rules that must be respected when writing into the relevant
files.
Synonym: Relationship

Live Data
Mechanism that consists in displaying real data coming from the database when creating the GUI.
This mechanism is used only if the element is linked to the data file.

Local
Corresponds to the scope in memory of a variable or procedure. A local element can only be
accessed in the process where it was defined. The opposite is global.

Member
Variable belonging to a class.

Method
Procedure belonging to a class used to act on the data (members) of the class.

Native access (connector)

Method for connecting to a database from a program.

448 Part 8: Appendices

n-tier
Programming method that is using layers. Each layer is independent and it can be changed
without impacting the other ones.

Object-Oriented Programming (OOP)

Advanced programming method, opposed to procedural programming.
In OOP, we handle objects, which means grouped sets of variables and methods associated with
entities that include these variables and these methods.

Parameter (window, page, report, procedure, method)

Element expected in a window, page, report, procedure or method during the call to this one. Each
value passed in parameter must be assigned to a variable.

Popup
Type of window (or page). A popup is a window (or a page) that is opened on top of another window
(or page). You can still see the content of the window (or page) underneath while performing the
input in the popup.

Popup menu
Drop-down menu containing the possible actions depending on the location where the right
mouse click was performed and on the type of element onto which this right click was performed.

Private
Variable or procedure that can only be used in the current element.

Procedural programming
Type of programming. In procedural programming, we define functions that call each others. Each
function or procedure is associated with a specific process that can be divided into sub-processes
until we get basic functions.

Procedure
Project element containing the code of a process to run.

Project
Element that groups all the elements that constitute a program or a site. A project contains for
example an analysis, pages, reports, queries, ...

Project code
Code run when starting a program or a site.

Project configuration
Description of the output format of a project: Windows executable, Linux, JAVA, ...

Part 8: Appendices 449

 Property (control, window, ...)
Keyword representing a characteristic of an element. The properties are used to handle and
modify the characteristics of the project elements by programming.

Public
Variable or procedure that can be used from all the elements.

Query
Element written in SQL language that is used to access (in read-only or in read/write) the content
of a relational database.

RAD
Abbreviation of Rapid Application Development
Fast development method of a program from an analysis (description of data files).

Report
Project element that defines a print to perform.

Report block
Element constituting a report. For example, a Page Header block, a Page Footer block, a Body
block.

Report template
Container representing a standard report that can be applied to a report or to several project
reports.

SCM
Abbreviation of Source Code Manager. Tool for organizing, sharing the source codes of projects,
managing rights, ...

Style
Element used to describe the graphic style of a control found in a window, in a page or in a report.
A style includes for example a type of font, the size of characters, the color of characters, etc.

Style sheet
Contains the list of styles used in a project.

Structure
Type of variable that includes several sub-variables.

Table
Type of variable that contains several values. The values can be accessed via a subscript. The [ ]
characters are used access the array elements.

450 Part 8: Appendices

Table (control)
Graphic element found in a window or in a page. A table control includes one or more columns
and rows.

Table (file)
Element that constitutes a database. A table is used to store the data entered in a program. For
example, a CUSTOMER table will contain the customer names and addresses that have been
entered in a program.

User groupware
Tool for describing the access rights to the GUI for the users of a program or site. For example,
prevent a user from being able to click a "Delete" button according to his login or to his group.

Variable
Element used to store a program value in memory. Several types of variables are available. Each
type corresponds to the nature of the value that will be stored. For example, a string variable to
store the name of a person, a currency variable to store an amount.

Webservice
Program installed on a Web server whose processes are accessible via the Web.

Window template
Container representing a standard window that can be applied to a window or to several project
windows.

XML
Language for organizing data in order to normalize and simplify the exchange of data (mainly used
in the exchanges with the Webservices).

Part 8: Appendices 451

 Appendice 2.  Using SQL data

This lesson will teach you the following concepts...

• Creating a project
• Creating an analysis

Estimated time: 40 min

452 Part 8: Appendices

Overview
This lesson allows you to handle the SQL databases with WINDEV.

This lesson is intended to the users with a good knowledge of SQL databases.
Notes

Some operations to perform on the SQL database will not be presented in details

To create an application that is using an SQL database, you must:

• Create the project linked to the application. This project will group all the application elements
(windows, codes, queries, reports, ...).
• Importing a preset description of SQL data file.

To follow this lesson, you must:

1. Connect to your SQL server.
2. Import the SQL script files and the image directory (found in the "\Tutorial\
Exercises\SQLDatabase\") onto the SQL server with the available import
Notes

tools (MySql, Oracle, SQL Server, ...). The image directory is used to get the
images of the Product file.
3. Run the SQL script files on the SQL server.
Your SQL database is ready for this lesson.

Creating the project

To create the project:

1. Start WINDEV (if not already done). Close the current project if necessary.
2. In the home window, click the "Create a project" button and select "Windows or Linux
application". The wizard for project creation starts. The different wizard steps help you create
your project. The information specified in this wizard can be modified later.

Tip: To create a project, you can also:

Tip

1. Click among the quick access buttons.

2. The window for creating a new element is displayed: click "Project".

3. The first wizard step is used to enter the name of the project, its location and its description.
In our case, this project will be named "sqldatabase".
4. The different wizard steps are specified on the left of the wizard. These steps can be clicked
directly. The other screens in the "Description" step being not fundamental, click "Charters"
directly.
5. This step is used to define the programming charter. Don't modify the suggested options.
Go to the next step via the arrows found at the bottom.
6. This step is used to define the style book. Select "Elegant". Go to the next step via the
arrows found at the bottom.

Part 8: Appendices 453

 7. Click the "Did you know it" step. This step is used to manage the display of a "Did you know
it" window.
We won't display this window: select "Don't display the 'Did you know it' window when starting
the application". Go to the next step.
8. We are now going to specify the information regarding the database.
9. Select "Yes, use an existing database" and go to the next step.

10. Select "Import the description from an existing database".

11. The wizard for analysis creation starts.

454 Part 8: Appendices

Creating the analysis

The wizard steps for analysis creation are as follows:

1. Specify the analysis name and directory. By default, the analysis name corresponds to the
project name and the analysis directory is a ".ana" directory in the project directory. We will keep
these default parameters. Go to the next wizard step.

2. You now have the ability to choose the types of databases used by the project. Select OLE
DB (or the SQL database use if you own the corresponding Native Access).
Note: The Native Access are listed first.

Go to the next wizard step.

3. Select the OLE DB source corresponding to the type of your database.
Go to the next wizard step.
4. In the following steps, specify the parameters of your OLE DB connection (the steps are
identical for a Native Access):
• the name of the connection (the caption associated with the connection is optional). Go to
the next step.

Part 8: Appendices 455

 • the name of the database server. Go to the next step.
• the user name and password. Go to the next step.
• the database name if necessary. Go to the next step.
5. Specify the mode for accessing the data. You can:
• access the data in its current format directly. Only the description of tables is imported into
the analysis. No conversion is required.
• convert the data to the HFSQL Classic format.

6. In our case, choose "Access the data in its current format directly". Go to the next step.
7. Select the tables (files) to import.

8. Validate and end the wizard. The tables are imported and viewed into the data model editor.

456 Part 8: Appendices

The analysis is as follows:

Generating the analysis

Generating the analysis consists in validating the modifications performed in the analysis (creation
of data files, addition or deletion of items, ...) and to apply them to the entire project (pages, linked
controls, reports, ...)

The generation is automatically proposed when closing the data model editor while the
modifications have been performed.
You also have the ability to generate the analysis manually. That's what we are going to do.
To generate the analysis:
1. In the data model editor, on the "Analysis" pane, in the "Analysis" group, click "Generation".
2. The generation of the analysis is automatically started.

When your analysis is generated, the data can be handled like the HFSQL data. There is no
difference. You can:
• Create a complete application by RAD (Rapid Application Development). See “Lesson 3.4. The
full RAD”, page 118 for more details.
• Create a complete custom application. See part 4, page 127, for more details.

Part 8: Appendices 457

 458 Conclusion
 Conclusion
The tutorial is over now!

This course has discussed a wide range of topics, but not all the features of WINDEV, far from it!
You are now familiar with the main concepts.

You can also explore the examples supplied with WINDEV: some are simple and only address
one topic while others are more complex. These examples will show you the different aspects of
WINDEV. Reading the source code is also a good way to learn.

It would take too much time to discuss all the available topics (there are hundreds, even
thousands!). WINDEV proposes several other features not presented in this tutorial:
• HTTP and telephony functions
• creation of skin templates...
• nested reports, queries with parameters...
• dynamic compilation, calls to DLL, external languages...

See the online help for more details.

We wish you a great development experience with WINDEV 22!

Conclusion 459