Returns the subscript of the break header and footer for a given break in a Table 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 20 and later
New in version 20Versions 22 and later New in version 22
HeaderSubscript is int
// Retrieves the subscript of the break header for the selected row
HeaderSubscript = TableBreakSubscript(BRK_BreakHeader)
// Adds a row into the Table control
RowSubscript is int
RowSubscript = TableAddLine(TABLE_Articles, ProductName, ...
SupplierName, UnitPrice)
// Retrieves the subscript of the break header for the added row
HeaderSubscript = TableBreakSubscript(BRK_BreakHeader, RowSubscript)
// Fixes the value of the static found in the break
TABLE_Articles[HeaderSubscript].STC_Supplier = SupplierName
Syntax
<Result> = TableBreakSubscript(<Break header/footer> [, <Subscript>])
<Result>: Integer
- Subscript of the break header/footer in the break containing the row whose subscript is <Subscript>,
- 0 if an error occurred. To find out the error details, use ErrorInfo associated with the errMessage constant.
<Break header/footer>: Control name
Name of break header or footer to use.
This parameter can correspond to: - <Name of break header/footer>.
- <Table 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 in the break containing the current row is returned.
Remarks
Use conditions
TableBreakSubscript can be used on a browsing or memory Table control,
We advise you to call TableBreakSubscript once the content of the Table control is entirely displayed. Otherwise, the subscripts returned by TableBreakSubscript may not correspond to the subscripts actually displayed in the control.