ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / Table control
  • Overview
  • How to?
  • Adding a break into a Table control
  • Break header and footer
  • How to fill a Table control with breaks?
  • Manipulating the controls found in the break headers and footers
  • How to?
  • Example
  • Automatic calculations in the breaks of a Table control
  • Handling the break headers and footers
  • To initialize the break headers and footers
  • Properties associated with the break headers and footers
  • WLanguage functions specific to Table controls with breaks
  • Managing breaks in the Table controls through programming
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Overview
A break in a Table control is used to group rows according to one or more criteria.
For example, you have the ability to group:
  • the customers by country and by city,
  • the products according to their family, ...
WINDEV Implementing a total on a break is used to automatically perform a calculation (sum, count, average) for all the rows found in a given break. For example, a total on a break is used to calculate the turnover generated by each customer.
The breaks in a Table control are available for:
  • the browsing Table controls loaded in memory,
  • the Table controls populated programmatically.
  • WEBDEV - Server codeWEBDEV - Browser codePHP the Table controls in Standard, Ajax and Browser mode.
WINDEV Remarks:
How to?

Adding a break into a Table control

To add a break into a Table control:
  1. Display the description of the Table control ("Description" from the popup menu).
  2. In the "Content" tab, click Icon for break addition. The window for break management is displayed.
    Remark: The breaks are not available for the browsing Table controls with direct access.
  3. Select the item on which the break must be performed. Several items can be selected in order to perform several breaks. The proposed items depend on the type of the Table control:
    • Table control based on a data file loaded in memory:
      • automatic browse: the search item, the column linked to the search item and the columns linked to no item are proposed. If the search item corresponds to a composite key, the components of this composite key, the columns linked to these components and the columns linked to no item are proposed.
      • programmed browse: the items of data file and the columns linked to these items are proposed.
    • Table control based on a data file linked to a query:
      • automatic browse: the search item, the columns linked to this search item and the columns linked to no item are proposed. If the search item is not specified ("<Automatic>" option), the sorted items of the query, the columns linked to these items and the columns linked to no item are proposed.
      • programmed browse: the query items, the columns linked to these items and the columns linked to no item are proposed.
    • Table control populated programmatically: all the columns found in the Table control are proposed.
  4. The breaks are performed according to their display order. Modify (if necessary) this order via the arrow buttons found on the right of table.
  5. Validate.

Break header and footer

When adding a new break, a break header and a break footer are automatically added to the Table control. If the Table control includes several breaks, there will be as many break headers and break footers as the number of breaks.
The break headers and the break footers appear in edit in the Table control.
The characteristics of these break headers and footers (name, visibility, background color, ...) can be modified in their description window ("Description" from the popup menu).
Each break header and break footer is associated with the "Display a row" event. This event is run when a new break header or break footer is displayed in the Table control.
These break headers and footers can contain controls. These controls can be handled through programming. Various WLanguage events are associated with break headers.
WINDEV The sums, means and counts are automatically performed in the breaks of the Table control. The controls found in the break headers and footers can display these calculations. For more details, see Automatic calculations in the table breaks.
Remarks:
  • WINDEVAndroidiPhone/iPad In the description of the Table control ("Content" tab), you have the ability to specify whether the breaks must display (or not) a button used to collapse/expand the break ("Breaks with collapse/expand" option).
  • WEBDEV - Server codeWEBDEV - Browser codePHP In the description of the Table control ("Details" tab), if the type of fill is "Loaded in memory", the breaks can be collapsed/expanded via a simple click in the background of the break ("Collapsible/Expandable breaks via simple click in the background").
  • WINDEVAndroidiPhone/iPad In the description of the Table control, you have the ability to configure the image used to draw the "+" and "-" buttons in the table breaks. To do so, select the "Break, border in creation" element in the "Style" table then click the "Plus/Minus image of breaks" button.
  • WINDEVAndroidiPhone/iPad A break header can be always visible. In this case, during the scroll, the bar of the break will not be moved. In order for a break header to be always visible:
    • Select the break header and display its description ("Description" in the context menu).
    • In the "UI" tab, check "Break header always visible".

How to fill a Table control with breaks?

For the Table controls based on a data file, the addition of records is automatically performed according to the file or to the associated query. The sort is performed according to the search item.
For Table controls populated programmatically, data is added with TableAddLine. In order for a Table control to be sorted according to the specified breaks, you must use TableSort.
Example: Table control populated programmatically: A break was defined on the Country and City columns:
// Fill the Table control
TableAddLine(TABLE_Breaks, "FRANCE", "Montpellier", "TEXT1", "Text1")
TableAddLine(TABLE_Breaks, "FRANCE", "Paris", "TEXT2", "Text2")
TableAddLine(TABLE_Breaks, "FRANCE", "Montpellier", "TEXT3", "Text3")
TableAddLine(TABLE_Breaks, "FRANCE", "Lille", "TEXT4", "Text4")

TableAddLine(TABLE_Breaks, "SPAIN", "Madrid", "TEXT1", "Text1")
TableAddLine(TABLE_Breaks, "SPAIN", "Barcelona", "TEXT3", "Text3")
TableAddLine(TABLE_Breaks, "SPAIN", "Barcelona", "TEXT4", "Text4")

TableAddLine(TABLE_Breaks, "ALGERIA", "Alger", "TEXT5", "Text5")
TableAddLine(TABLE_Breaks, "ALGERIA", "Oran", "TEXT6", "Text6")
TableAddLine(TABLE_Breaks, "ALGERIA", "Alger", "TEXT7", "Text7")
TableAddLine(TABLE_Breaks, "ALGERIA", "Chlef", "TEXT8", "Text8")
TableAddLine(TABLE_Breaks, "ALGERIA", "Alger", "TEXT9", "Text9")

TableAddLine(TABLE_Breaks, "SPAIN", "Madrid", "TEXT2", "Text2")

// Sort the content of the Table control according to the breaks
TableSort(TABLE_Breaks, TABLE_Breaks.Country.Name, TABLE_Breaks.City.Name)
Manipulating the controls found in the break headers and footers

How to?

To manipulate the controls found in the break headers and footers
  • handle each control found in all the break headers and footers:
    <Control name>.<Property name> = <Value>
    or
    <Table name>.<Break header/footer name>.<Control name>.<Property name> = <Value>
  • handle each control found in a given break:
    <Table name>[<Index>].<Control name>.<Property name> = <Value>

    <Subscript> corresponds to the row number for the break.
Remarks:
  • These lines of code must be in the "Display a row" event of the break header / footer.
  • Special case: Check Box control: a Check Box control containing several options and located in the break headers and footers cannot be assigned through programming. If several check boxes are required in the break headers and footers, we recommend that you use a Check Box control for each checkmark.

Example

This code is used to display in the "STC_Country" control the name of the country displayed in the Country column. This code is entered in the code for displaying a row of BreakHeader:
// Code for displaying the break
// Retrieves the index of the break (BRK_BreakHeader) 
BreakIndex is int = TableBreakIndex(BRK_BreakHeader)

// Fixes the value of the text in the break
TABLE_CUSTOMERS[BreakIndex].STC_COUNTRY = "Country: " + TABLE_Articles.COL_CountryName
Automatic calculations in the breaks of a Table control
WINDEV
You have the ability to perform automatic calculations (sum, count and average) in the break headers and footers.
To implement the automatic calculations:
  1. Insert a Static control or an edit control into the break header and footer. This control will contain the automatic calculation.
  2. Open the control description window (select "Description" in the context menu).
  3. In the "UI" tab, in the "In a break, display" area, click the "No calculation" link or click the calculation description (if an automatic calculation was already defined). The description window of an automatic calculation is displayed.
  4. Select the calculation to perform. You can choose:
    • "The sum of": the control will display the sum per break.
    • "The average of": the control will display the average on the break.
    • "The number (count) of": the control will count the number of elements per break.
  5. Select the element on which the calculation must be performed. You have the ability to perform the calculation on a column of the Table control.
  6. Validate the different windows.
Tips:
  • Don't forget to modify the input mask of the control that displays the calculation according to the type of calculated information.
  • Don't hesitate to use the "eye magnet" technology on the edit controls that display calculations in the breaks. This gives you the ability you to highlight a calculation (displaying an insufficient turnover in red for example).
Handling the break headers and footers

To initialize the break headers and footers

All the break headers and footers can handled:
<Break header/footer name>.<Property name> = <Value>
Remark: These lines of code must be in the "Display a row" event of the break header/footer.
Example: Code used to modify the height of the break headers:
BreakHeader1.Height += 10

Properties associated with the break headers and footers

The following properties are associated with the break headers and footers:
CollapsedAllows you to find out and modify the "collapsed" status of a break.
HeightAllows you to find out and modify the height of a break header or footer.
WEBDEV - Server code Not available.
NameReturns the name of a break header or footer.
TypeReturns the type of an element.
VisibleAllows you to find out whether a break header or footer is visible and to make a break header or footer visible.

For a complete list of available properties, see Properties available for the breaks (Table).
WLanguage functions specific to Table controls with breaks
The following functions can be used to manipulate the breaks in the Table controls:
TableBreakIndexReturns the index of the break header and footer for a given break in a Table control.
TableCollapseCollapses:
  • a branch that was previously expanded in a TreeView Table control.
  • a break that was previously expanded in a Table control.
  • a detailed window displayed for a row.
TableCollapseAllCollapses:
  • the entire hierarchy (all nodes) of a TreeView Table control.
  • all breaks of a Table control.
TableExpandExpands:
  • a branch that was previously collapsed in a TreeView Table control.
  • a branch that was previously collapsed in a Table control.
  • a detailed window displayed for a row.
TableExpandAllExpands:
  • the entire hierarchy (all nodes) of a TreeView Table control.
  • all breaks of a Table control.
WINDEV
Managing breaks in the Table controls through programming
The following functions are used to create and handle breaks in the tables:
BreakAddAdds a break into a Table or Looper control.
BreakDeleteDeletes a break from a Table control or from a Looper control.
BreakDeleteAllDeletes all breaks from a Table control or from a Looper control.
Adding a break into a table is performed by BreakAdd. The new break corresponds to a variable of type Control that can be handled with the same WLanguage properties as a break created in the editor.
Example:
// Add a green break on the date into the Table control
x is Control
x <- BreakAdd(TABLE_Order.COL_DATE, "BrkDate", brkHeader, 50) 
x.BackgroundColor = DarkGreen // Applies green color to the break
Related Examples:
The Table control with break Unit examples (WINDEV): The Table control with break
[ + ] Using the Table control with break.
Minimum version required
  • Version 14
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 10/02/2023

Send a report | Local help