Returns the index of the break header and footer for a given break in a Table control.
The index of the break header for a given break also corresponds to the index of the first row in this break.
The index of the break footer for a given break also corresponds to the index of the last row in this break.
Versions 20 and later
New in version 20Versions 22 and later New in version 22
HeaderIndex is int
// Retrieves the index of the break header for the selected row
HeaderIndex = BRK_BreakHeader.BreakSubscript()
// Adds a row into the Table control
RowIndex is int
RowIndex = TABLE_Articles.AddLine(ProductName, ...
SupplierName, UnitPrice)
// Retrieves the index of the break header for the added row
HeaderIndex = BRK_BreakHeader.BreakSubscript(RowIndex)
// Fixes the value of the text in the break
TABLE_Articles[HeaderIndex].STC_Supplier = SupplierName
Syntax
<Result> = <Break header/footer>.BreakSubscript([<Subscript>])
<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.
<Subscript>: 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>.BreakSubscript can be used on a Table control based on a data file or populated programmatically.
It is recommended to call <Table>.BreakSubscript once the content of the Table control is entirely displayed. Otherwise, the indices returned by <Table>.BreakSubscript may not correspond to the actual indices displayed in the control