PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Overview
  • Adding a break
  • Adding a break
  • Break header and footer
  • Image of break buttons
  • Handling the controls found in the break headers and footers
  • Initializing the controls found in the break headers and footers
  • Retrieving the value of controls found in the break headers and footers
  • Automatic calculations in the looper breaks
  • Handling the break headers and footers by programming
  • Initializing the break headers and footers
  • Functions associated with break headers and footers
  • Properties associated with the break headers and footers
  • Managing breaks in the Looper controls by programming
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Overview
A break in a looper is used to group the data corresponding to one or more arguments.
For example, you can list:
  • the customers by country and by city,
  • the invoices per customer,
  • the products according to their family and sub-family, ...
The breaks in the loopers are available for:
  • The browsing Looper controls loaded in memory.
  • The memory Looper controls.
  • Versions 17 and later
    WEBDEV - Server codeWEBDEV - Browser code the Looper controls in Standard, Ajax and Browser mode.
    New in version 17
    WEBDEV - Server codeWEBDEV - Browser code the Looper controls in Standard, Ajax and Browser mode.
    WEBDEV - Server codeWEBDEV - Browser code the Looper controls in Standard, Ajax and Browser mode.
Java The breaks are not available in Java.
Versions 20 and later
WINDEV Notes:
New in version 20
WINDEV Notes:
WINDEV Notes:
Versions 17 and later
WINDEV MobileiPhone/iPad The breaks in the loopers are now available for the iPhone/iPad applications.
WINDEV MobileAndroid The breaks in the loopers are now available for the Android applications.
WEBDEV - Browser code The breaks in the loopers are now available for the Browser loopers.
Android The breaks in the loopers are not available in the multi-column loopers.
New in version 17
WINDEV MobileiPhone/iPad The breaks in the loopers are now available for the iPhone/iPad applications.
WINDEV MobileAndroid The breaks in the loopers are now available for the Android applications.
WEBDEV - Browser code The breaks in the loopers are now available for the Browser loopers.
Android The breaks in the loopers are not available in the multi-column loopers.
WINDEV MobileiPhone/iPad The breaks in the loopers are now available for the iPhone/iPad applications.
WINDEV MobileAndroid The breaks in the loopers are now available for the Android applications.
WEBDEV - Browser code The breaks in the loopers are now available for the Browser loopers.
Android The breaks in the loopers are not available in the multi-column loopers.
Adding a break

Adding a break

To add a break into a Looper control:
  1. Display the description window of the Looper control ("Description" from the popup menu).
  2. In the "Content" tab, click Break button . The window for break management is displayed:
    Defining the breaks
  3. Select the item or the attribute on which a break must be performed. Several items and/or attributes can be selected in order to implement several breaks.
    The suggested items and attributes depend on the type of looper:
    • In a Looper control linked to a data file:
      • automatic browse: the search item, the attributes linked to this search item and the attributes linked to no item are proposed. If the search item corresponds to a composite key, the components of this composite key, the attributes linked to these components and the attributes linked to no item are proposed.
      • programmed browse: the items of the data file, the attributes linked to these items and the attributes linked to no item are proposed.
    • In a Looper control linked to a query:
      • automatic browse: the search item, the attributes linked to this search item and the attributes linked to no item are proposed. If the search item is not specified ("<Automatic>" option), the sorted query items, the attributes linked to these items and the attributes linked to no item are proposed.
      • programmed browse: the query items, the attributes linked to these items and the attributes linked to no item are proposed.
    • In a memory looper, all looper attributes are proposed.
  4. Validate the window for break management.
  5. The breaks will be performed according to the order in which they are displayed in the table of breaks found in the "Content" tab of the looper description. Modify (if necessary) this order via the arrow buttons found on the right of the table.
  6. Versions 17 and later
    WINDEVWindows Specify whether the breaks must be "Breaks with collapsed/expanded". If this option is checked, a "+ /-" button is automatically added into the break header. This button will allow the user to collapse or expand the break. Specifies the operating mode of breaks:
    • WINDEVWINDEV MobileWindowsLinuxAndroidiPhone/iPad whether breaks must be "Breaks with collapsed/expanded". If this option is checked, a "+ /-" button is automatically added into the break header. This button will allow the user to collapse or expand the break.
    • WEBDEV - Server codePHP whether breaks must be "Collapsable/Expandable breaks via a simple click in the background". If this option is checked, the user will have the ability to click in the break header to collapse or expand the break according to his own requirements.
    New in version 17
    WINDEVWindows Specify whether the breaks must be "Breaks with collapsed/expanded". If this option is checked, a "+ /-" button is automatically added into the break header. This button will allow the user to collapse or expand the break. Specifies the operating mode of breaks:
    • WINDEVWINDEV MobileWindowsLinuxAndroidiPhone/iPad whether breaks must be "Breaks with collapsed/expanded". If this option is checked, a "+ /-" button is automatically added into the break header. This button will allow the user to collapse or expand the break.
    • WEBDEV - Server codePHP whether breaks must be "Collapsable/Expandable breaks via a simple click in the background". If this option is checked, the user will have the ability to click in the break header to collapse or expand the break according to his own requirements.
    WINDEVWindows Specify whether the breaks must be "Breaks with collapsed/expanded". If this option is checked, a "+ /-" button is automatically added into the break header. This button will allow the user to collapse or expand the break. Specifies the operating mode of breaks:
    • WINDEVWINDEV MobileWindowsLinuxAndroidiPhone/iPad whether breaks must be "Breaks with collapsed/expanded". If this option is checked, a "+ /-" button is automatically added into the break header. This button will allow the user to collapse or expand the break.
    • WEBDEV - Server codePHP whether breaks must be "Collapsable/Expandable breaks via a simple click in the background". If this option is checked, the user will have the ability to click in the break header to collapse or expand the break according to his own requirements.
  7. Validate.
Notes:
  • Breaks can be created in the single-column loopers and in the multicolumn loopers.
  • Versions 18 and later
    WINDEVWindows Mobile 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" from the popup menu).
    • In the "GUI" tab, check "Break header always visible".
    New in version 18
    WINDEVWindows Mobile 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" from the popup menu).
    • In the "GUI" tab, check "Break header always visible".
    WINDEVWindows Mobile 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" from the popup menu).
    • In the "GUI" tab, check "Break header always visible".
    WINDEVAndroidiPhone/iPadWindows Mobile 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" from the popup menu).
    • In the "GUI" tab, check "Break header always visible".

Break header and footer

When adding a new break, a break header and a break footer are automatically added to the looper. If the looper includes several breaks, there will be as many break headers and break footers as the number of breaks.
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 "Row display" process. This process is run when a new break header or break footer is displayed in the looper.
These break headers and footers can contain controls. These controls can be handled by programming.
Versions 16 and later
WINDEVWindowsLinux The sums, averages and counts are automatic in the looper breaks. The controls found in the break headers and footers can display these calculations. See automatic calculations in the looper breaks for more details.
New in version 16
WINDEVWindowsLinux The sums, averages and counts are automatic in the looper breaks. The controls found in the break headers and footers can display these calculations. See automatic calculations in the looper breaks for more details.
WINDEVWindowsLinux The sums, averages and counts are automatic in the looper breaks. The controls found in the break headers and footers can display these calculations. See automatic calculations in the looper breaks for more details.

Image of break buttons

To modify the image of break buttons:
  1. Display the description window of the Looper control ("Description" from the popup menu).
  2. A break is defined in the "Content" tab.
  3. In the "Style" tab, select the "Break, border in creation" element.
  4. Click the "Plus/Minus image of breaks" button.
  5. In the area that is displayed, enter the path of the image for the break button. This image is an image with 2 states (plus and minus) in 24 x 12 format.
    Customizing the break buttons
Handling the controls found in the break headers and footers

Initializing the controls found in the break headers and footers

To initialize 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
    <Looper Name>.<Name of Break Header/Footer>.<Control Name>..<Property Name> = <Value>
    If <Property Name> corresponds to ..Value, the value of the specified control for the current row is modified
  • handle each control found in a given break:
    <Looper Name>[<Subscript>].<Control Name>..<Property Name> = <Value>
    <Subscript> must correspond to one of the rows found in the specified break.
  • handle each attribute found in all the break headers and footers:
    <Attribute Name> = <Value>
    The property associated with <Attribute Name> will be initialized.
  • handle each attribute of a given break:
    <Attribute Name>[<Subscript>] = <Value>
    The property associated with <Attribute Name> will be initialized.
    <Subscript> must correspond to one of the rows found in the specified break.
Note: These code lines must be found in the "Display process of a row found in the break header/footer".

Retrieving the value of controls found in the break headers and footers

To retrieve the value of controls found in the break headers and footers:
  • handle each control found in the current break:
    <Value> = <Control Name>..<Property Name>
    or
    <Value> = <Looper Name>.<Break Header/Footer Name>.<Control Name>..<Property Name>
  • handle each control found in a given break:
    <Value> = <Looper Name>[<Subscript>].<Control Name>..<Property Name>
    <Subscript> must correspond to one of the rows found in the specified break.
  • handle each attribute found in all the break headers and footers:
    <Value> = <Attribute Name>
    The value of the property associated with <Attribute Name> will be retrieved.
  • handle each attribute of a given break:
    <Value> = <Attribute Name>[<Subscript>]
    The value of the property associated with <Attribute Name> will be retrieved.
    <Subscript> must correspond to one of the rows found in the specified break.
Note: These code lines must be found in the "Display process of a row found in the break header/footer".
Versions 16 and later
WINDEV
Automatic calculations in the looper breaks
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.
  2. Display the description window of control ("Description" from the popup menu).
  3. In the "GUI" 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 to:
    • "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. The calculation can be performed on:
    • A control: the calculation will be performed on the value property of control.
    • An attribute of the looper: the calculation will be performed by using the attribute property.
    • An item of the data file (for the browsing loopers).
  6. Validate.
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).
New in version 16
WINDEV
Automatic calculations in the looper breaks
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.
  2. Display the description window of control ("Description" from the popup menu).
  3. In the "GUI" 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 to:
    • "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. The calculation can be performed on:
    • A control: the calculation will be performed on the value property of control.
    • An attribute of the looper: the calculation will be performed by using the attribute property.
    • An item of the data file (for the browsing loopers).
  6. Validate.
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).
WINDEV
Automatic calculations in the looper breaks
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.
  2. Display the description window of control ("Description" from the popup menu).
  3. In the "GUI" 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 to:
    • "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. The calculation can be performed on:
    • A control: the calculation will be performed on the value property of control.
    • An attribute of the looper: the calculation will be performed by using the attribute property.
    • An item of the data file (for the browsing loopers).
  6. Validate.
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 by programming

Initializing the break headers and footers

To initialize the break headers and footers, use the following syntax:
<Name of Break Header/Footer>..<Property Name> = <Value>
Note: These code lines must be found in the "Display process of a row found in the break header/footer".

Functions associated with break headers and footers

The following functions are associated with the break headers and footers:
Versions 10 and later
LooperBreakSubscript
New in version 10
LooperBreakSubscript
LooperBreakSubscript
Returns the subscript of the break header and footer for a given break in a Looper control
Versions 17 and later
LooperCollapse
New in version 17
LooperCollapse
LooperCollapse
Collapses a break that was expanded beforehand in a Looper control
Versions 17 and later
LooperCollapseAll
New in version 17
LooperCollapseAll
LooperCollapseAll
Collapses all the expanded breaks in a Looper control
Versions 17 and later
LooperCollapseExpand
New in version 17
LooperCollapseExpand
LooperCollapseExpand
On a given row in a Looper control
  • collapses a break (if it is expanded),
  • expands a break (if it is collapsed)
Versions 17 and later
LooperExpand
New in version 17
LooperExpand
LooperExpand
Expands a break in the Looper control on a given row
Versions 17 and later
LooperExpandAll
New in version 17
LooperExpandAll
LooperExpandAll
Expands all the breaks in a Looper control with break

Properties associated with the break headers and footers

Several properties are used to handle the breaks by programming, especially:
Collapsed..Collapsed is used to:
  • find out or define the status (collapsed or expanded) that will be used when rows are added into a Treeview Table control.
  • find out or modify the collapsed/expanded status for
    • the breaks of a Table control,
    • the breaks of a Looper control,
    • a HideShow control,
    • a Ribbon control,
    • a Navigation Bar control
    • a Pivot Table control in a report.
To find out the entire list of available properties, see Properties available for the breaks (Looper).
Versions 22 and later
WINDEV
Managing breaks in the Looper controls by programming
The following functions are used to create and handle breaks in the Looper controls:
Versions 22 and later
BreakAdd
New in version 22
BreakAdd
BreakAdd
Adds a break into a Table control or into a Looper control.
Versions 22 and later
BreakDelete
New in version 22
BreakDelete
BreakDelete
Deletes a break from a Table control or from a Looper control.
Versions 22 and later
BreakDeleteAll
New in version 22
BreakDeleteAll
BreakDeleteAll
Deletes all the breaks from a Table control or from a Looper control.
Adding a break into a looper is performed by BreakAdd. The created break corresponds to a Control variable that can be handled by the same WLanguage properties as a break created in the editor.
New in version 22
WINDEV
Managing breaks in the Looper controls by programming
The following functions are used to create and handle breaks in the Looper controls:
Versions 22 and later
BreakAdd
New in version 22
BreakAdd
BreakAdd
Adds a break into a Table control or into a Looper control.
Versions 22 and later
BreakDelete
New in version 22
BreakDelete
BreakDelete
Deletes a break from a Table control or from a Looper control.
Versions 22 and later
BreakDeleteAll
New in version 22
BreakDeleteAll
BreakDeleteAll
Deletes all the breaks from a Table control or from a Looper control.
Adding a break into a looper is performed by BreakAdd. The created break corresponds to a Control variable that can be handled by the same WLanguage properties as a break created in the editor.
WINDEV
Managing breaks in the Looper controls by programming
The following functions are used to create and handle breaks in the Looper controls:
Versions 22 and later
BreakAdd
New in version 22
BreakAdd
BreakAdd
Adds a break into a Table control or into a Looper control.
Versions 22 and later
BreakDelete
New in version 22
BreakDelete
BreakDelete
Deletes a break from a Table control or from a Looper control.
Versions 22 and later
BreakDeleteAll
New in version 22
BreakDeleteAll
BreakDeleteAll
Deletes all the breaks from a Table control or from a Looper control.
Adding a break into a looper is performed by BreakAdd. The created break corresponds to a Control variable that can be handled by the same WLanguage properties as a break created in the editor.
Related Examples:
eBusiness Complete examples (WEBDEV): eBusiness
[ + ] The eBusiness project is a full eBusiness site that can be entirely customized via a Web management interface.
- The showroom/payment section of the site is developed in AWP in order to get the best possible referencing of products.
- The management section of the site is developed in standard WD session to guarantee the maximum security.
Minimum required version
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment