TableBreakIndex (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 / Table functions

Use conditions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TableBreakIndex (Function)

In french: TableIndiceRupture

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

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

See additional examples

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

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

Syntax

<Result> = TableBreakIndex(<Break header/footer> [, <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.
This parameter can correspond to:
<Name of break header/footer>.
<Table 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 break header/footer in the break containing the current row is returned.

Remarks

Use conditions

TableBreakIndex can be used on a Table control based on a data file or populated programmatically.

This function is available for Table controls in AJAX mode and for Table controls in classic mode.

This function is only available for Table fields in Browser mode.

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

Business / UI classification: UI Code

Component: wd300obj.dll