<Looper>.BreakSubscript (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Use conditions
Using LooperBreakSubscript

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Looper>.BreakSubscript (Function)

In french: <Zone répétée>.IndiceRupture

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

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

Versions 16 and later

This function is now available for PHP sites.

New in version 16

This function is now available for PHP sites.

This function is now available for PHP sites.

Versions 17 and later

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

New in version 17

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

Versions 20 and later

This function is now available in browser code.

New in version 20

This function is now available in browser code.

Example

// The LOOP_Invoices Looper control lists the invoices of each customer
// A break is performed for each customer
// The break footer contains the TotalInvoice control
// linked to the ATT_Total attribute
// This control displays the total of all invoices for each customer
MyRow is int = 1 // Beginning of the Looper control
BreakHeader is int // Subscript of break header
BreakFooter is int // Subscript of break footer
Subscript is int // Subscript of rows
Total is int // Total for each break

// Calculate the totals for the entire Looper control
WHILE MyRow <= LOOP_Invoices..Count
// Subscript of current break
BreakHeader = BRK_CustHeader.BreakSubscript(MyRow)
BreakFooter = BRK_CustFooter.BreakSubscript(MyRow)

// Browse the rows found in the current break
// to calculate the total
FOR Subscript = BreakHeader TO BreakFooter
Total += ATT_Value[Subscript]
END

// Assign the total
ATT_Total[BreakFooter] = Total

// Go to the next break
MyRow = BreakFooter + 1
END

Syntax

<Result> = <Break header/footer>.BreakSubscript([<Subscript>])

<Result>: Integer

Subscript of the specified break header/footer in the break containing the row whose subscript is <Subscript>,
0 if an error occurs. To find out the name of the error, use the function ErrorInfo with the constant errMessage.

<Break header/footer>: Control name

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

<Subscript>: Optional integer

Subscript of one of the rows found in the requested break.
If this parameter is not specified, the subscript of the break header/footer found in the break containing the current row is returned.

Remarks

Use conditions

<Looper>.BreakSubscript can be used on a browsing or memory Looper control.

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 LooperBreakSubscript

It is recommended to call <Looper>.BreakSubscript once the Looper control is displayed in its entirety. Otherwise, the subscripts returned by <Looper>.BreakSubscript may not correspond to the actual subscripts displayed in the Looper control.

Component: wd260obj.dll