<Table>.BreakIndex (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Use conditions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Table>.BreakIndex (Function)

In french: <Table>.IndiceRupture

Warning
From version 28 (75), Table.BreakSubscript is kept for backward compatibility. This function has been replaced with <Table>.BreakIndex.

Returns the index of the break header and footer for a given break in a Table 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

IndiceHaut is int
// Récupère l'indice du haut de rupture de la ligne sélectionnée
IndiceHaut = RUPT_HautDeRupture.IndiceRupture()

// Ajoute une ligne dans le champ Table
IndiceLigne is int
IndiceLigne = TABLE_Articles.AjouteLigne(NomProduit, NomFournisseur, PrixUnitaire)
// Récupère l'indice du haut de rupture de la ligne ajoutée
IndiceHaut = RUPT_HautDeRupture.IndiceRupture(IndiceLigne)
// Fixe la valeur du libellé contenu dans la rupture
TABLE_Articles[IndiceHaut].LIB_Fournisseur = NomFournisseur

Syntax

<Result> = <Break header/footer>.BreakIndex([<Index>])

<Result>: Integer

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

<Break header/footer>: Control name

Name of the break header or footer to be used.

<Index>: Optional integer

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

Remarks

Use conditions

<Table>.BreakIndex can be used on a Table control based on a data file or populated programmatically.

It is recommended to call <Table>.BreakIndex once the content of the Table control is entirely displayed. Otherwise, the indexes returned by <Table>.BreakIndex may not correspond to the actual indexes displayed in the control

Component: wd300obj.dll