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 20
HeaderSubscript is int
// Retrieves the subscript of the break header for the selected row
HeaderSubscript = BRK_BreakHeader.BreakSubscript()
// Adds a row into the Table control
RowSubscript is int
RowSubscript = TABLE_Articles.AddLine(ProductName, ...
SupplierName, UnitPrice)
// Retrieves the subscript of the break header for the added row
HeaderSubscript = BRK_BreakHeader.BreakSubscript(RowSubscript)
// Fixes the value of the static found in the break
TABLE_Articles[HeaderSubscript].STC_Supplier = SupplierName
Syntax
<Result> = <Break header/footer>.BreakSubscript([<Subscript>])
<Result>: Integer
- Subscript of the break header/footer in the break containing the row whose subscript is <Subscript>,
- 0 if an error occurs. To get the details of the error, use ErrorInfo with the errMessage constant.
<Break header/footer>: Control name
Name of break header or footer to use.
<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
<Table>.BreakSubscript can be used on a browsing or memory Table control,
We advise you to call <Table>.BreakSubscript once the content of the Table control is entirely displayed. Otherwise, the subscripts returned by <Table>.BreakSubscript may not correspond to the subscripts actually displayed in the control.