Query documentation

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

WINDEV

WEBDEV

WINDEV Mobile

Others

Query documentation

Overview

The query editor automatically creates a program documentation for each query. This documentation contains:

the graphic representation of the query.
the general information about the query (logical name and physical name of the query, type of query, analysis associated with the query, ...).
the information specific to the query results (result items, query parameters, sort criteria, ...).
the information about the query characteristics (selection conditions, groups, ...).
the SQL code corresponding to the query.

The content of this documentation can be customized, it can contain:

How to proceed?

Editing the program documentation of current query in the editor

To edit the program documentation of current query in the editor:

Select "File .. Print the documentation".On the "Home" pane, in the "General" group, expand and select "Print".
Specify the information found in this documentation.
Choose the type of edit for the documentation.

Note: The print of the query representation can be configured according to:

print areas.
a specified layout ("File .. Documentation layout").a specific layout. To define this layout, expand and select "Documentation layout".

Specifying the print areas of graphic representation

To specify the print areas of graphic representation:

Select "Display .. Print areas". Borders representing the areas that can be printed in the documentation appear in the query editor.On the "Display" pane, in the "Help for edit" group, check "Print areas". Borders representing the areas that can be printed in the documentation appear in the query editor.
Reduce the display of graphic representation ("Display .. Zoom" or Ctrl + Mouse wheel) to see the entire query.Reduce the display of graphic representation: on the "Display" pane, in the "Help for edit" group, modify the "Zoom" value (or Ctrl + Mouse wheel) to see the entire query.
With the mouse:
- move these borders to the requested location by keeping the mouse button down (the mouse cursor is black).
- choose the number of pages on which the graphic representation must be printed (the mouse cursor turns into a North-West/South-East double arrow).