LooperBreakIndex (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Looper functions

Use conditions
Using the LooperBreakIndex function

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

LooperBreakIndex (Function)

In french: ZoneRépétéeIndiceRupture

Warning
From version 28 (75), LooperBreakSubscript is kept for backward compatibility. This function has been replaced with LooperBreakIndex.

Returns the index of the break header and footer for a given break in a Looper control:

The index of the header for a given break also corresponds to the index of the first row in this break.
The index of the footer for a given break also corresponds to the index of the last row in this break.

Example

// Le champ Zone répétée ZR_Factures liste les factures de chaque client
// Une rupture sur chaque client est effectuée
// Le bas de rupture contient le champ TotalFacture
// lié à l'attribut ATT_Total
// Ce champ affiche le total de toutes les factures de chaque client
MaRépétition is int = 1 // Début du champ Zone répétée
DébutRupture is int // Indice du haut de rupture
FinRupture is int // Indice du bas de rupture
Indice is int // Indice des répétitions
Total is int // Total de chaque rupture

// Calcul des totaux par rupture pour tout le champ Zone répétée
WHILE MaRépétition <= ZR_Factures.Occurrence
// Remise à 0 du total
Total = 0
// Indice de la rupture courante
DébutRupture = LooperBreakIndex(RUPT_HautClient, MaRépétition)
FinRupture = LooperBreakIndex(RUPT_BasClient, MaRépétition)

// Parcours des répétitions de la rupture courante
// pour calculer le total
FOR Indice = DébutRupture TO FinRupture
Total += ATT_Valeur[Indice]
END

// Affectation du total
ATT_Total[FinRupture] = Total

// Passage à la rupture suivante
MaRépétition = FinRupture + 1
END

Syntax

<Result> = LooperBreakIndex(<Break header/footer> [, <Index>])

<Result>: Integer

Index of the header/footer break specified in the break containing the row at index <Index>,
0 if an error occurs. To get more details on the error, use ErrorInfo with the errMessage constant.

<Break header/footer>: Character string

Name of the break header or footer to be used.
This parameter can correspond to:
the name of the break header or break footer directly.
<Name of Looper control>.<Name of break header/footer>

<Index>: Optional integer

Index of one of the rows in the desired break.
If this parameter is not specified, the index of the header/footer break specified in the break containing the current row is returned.

Remarks

Use conditions

LooperBreakIndex can be used on:

a Looper control based on a data file,
a Looper control populated programmatically.

This function is not available for Linear Looper controls. This function is available for Looper controls in browser mode only.

This function is available for Looper controls in AJAX mode, Looper controls in classic mode and Linear Looper controls.

Using the LooperBreakIndex function

It is recommended to call LooperBreakIndex once the Looper control is displayed in its entirety. Otherwise, the indexes returned by LooperBreakIndex may not correspond to the actual indexes displayed in the Looper control.

Business / UI classification: UI Code

Component: wd300obj.dll