PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • Overview
  • Add break
  • Add 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
  • 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
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 control 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 Looper controls are available for:
  • Browsing Looper controls loaded in memory.
  • Memory Looper controls.
  • Versions 17 and later
    WEBDEV - Server codeWEBDEV - Browser code Looper controls in Standard, Ajax and Browser mode.
    New in version 17
    WEBDEV - Server codeWEBDEV - Browser code Looper controls in Standard, Ajax and Browser mode.
    WEBDEV - Server codeWEBDEV - Browser code Looper controls in Standard, Ajax and Browser mode.
Versions 17 and later
WEBDEV - Browser code Breaks in Looper controls are now available for Browser Looper controls.
New in version 17
WEBDEV - Browser code Breaks in Looper controls are now available for Browser Looper controls.
WEBDEV - Browser code Breaks in Looper controls are now available for Browser Looper controls.
Add break

Add 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 control:
    • 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 table.
  6. Versions 17 and later
    Windows 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:
    • WindowsLinux 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
    Windows 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:
    • WindowsLinux 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.
    Windows 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:
    • WindowsLinux 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.
Remarks:
  • Breaks can be created in the single-column loopers and in the multicolumn loopers.

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 event "Displaying a row". This event is run when a new break header or break footer is displayed in the Looper control.
These break headers and footers can contain controls. These controls can be handled by programming.
Versions 16 and later
WindowsLinux 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
WindowsLinux 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.
WindowsLinux 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.
WindowsLinux

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, only 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.
Remark: These code lines must be in the event "Displaying a row of 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.
Remark: These code lines must be in the event "Displaying a row of break header / footer".
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>
Remark: These code lines must be in the event "Displaying a row of 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 expanded breaks in a Looper control.
Versions 17 and later
LooperCollapseExpand
New in version 17
LooperCollapseExpand
LooperCollapseExpand
On a given row of 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 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 Drawer 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).
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 version required
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment