ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Controls, pages and windows / Table functions
  • Use conditions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Warning
From version 28 (75), TableBreakSubscript is kept for backward compatibility. This function is replaced by TableBreakIndex.
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.
HeaderIndex is int
 
// Retrieves the index of the break header for the selected row
HeaderIndex = TableBreakIndex(BRK_BreakHeader)
// Adds a row into the Table control
RowIndex is int
RowIndex = TableAddLine(TABLE_Articles, ProductName, ...
SupplierName, UnitPrice)
 
// Retrieves the index of the break header for the added row
HeaderIndex = TableBreakIndex(BRK_BreakHeader, RowIndex)
 
// Fixes the value of the text in the break
TABLE_Articles[HeaderIndex].STC_Supplier = SupplierName
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.
WEBDEV - Server codePHP This function is available for Ajax Table controls and classic Table controls.
WEBDEV - Browser code This function is available for Table controls in browser mode only.
It is recommended to call TableBreakIndex once the content of the Table control is entirely displayed. Otherwise, the indices returned by TableBreakIndex may not correspond to the actual indices displayed in the control
Business / UI classification: UI Code
Component: wd290obj.dll
Minimum version required
  • Version 15
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 03/21/2023

Send a report | Local help